Struct InjectionSynchronousProxy

pub struct InjectionSynchronousProxy { /* private fields */ }

Implementations

impl InjectionSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<InjectionEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn write_input_audio( &self, index: i32, audio_writer: Socket, ) -> Result<(), Error>

Set the audio to be injected at index.

The first time this is called, an empty vector will be created, subsequent calls will append to audio_data to the same vector.

Use ClearInputAudio to clear audio input data stored at index.

Further requests on the same Injection connection are blocked until the audio_writer socket is drained completely. To determine when injection is complete, users may initiate a call to GetInputAudioSize immediately following the call to this method.

• request index refers a specific audio_data input record. We can have multiple records.
• request audio_writer socket where audio data will be loaded from.

pub fn get_input_audio_size( &self, index: i32, ___deadline: MonotonicInstant, ) -> Result<InjectionGetInputAudioSizeResult, Error>

Get the size of audio data stored at index.

This method returns the number of bytes of input data stored at the given index.

If a WriteInputAudio call is pending for the given index, this method will block until the socket is drained and the data is fully stored.

• request index refers to a specific audio_data input record.

• response error description of failure action to take.

pub fn clear_input_audio( &self, index: i32, ___deadline: MonotonicInstant, ) -> Result<InjectionClearInputAudioResult, Error>

Clears audio data stored at index.

If no data exists at index nothing will get cleared, but no error will be returned.

• request index refers a specific audio_data input record to clear.

• response error description of failure action to take.

pub fn wait_until_input_is_done( &self, ___deadline: MonotonicInstant, ) -> Result<InjectionWaitUntilInputIsDoneResult, Error>

Wait until injected inputs are done playing.

This function returns only when all injected audio tracks are complete.

This is intended to be called after calling StartInputInjection. If no tracks have been started, or all started tracks have already completed, then this function will immediately return without error.

• response error description of failure action to take.

pub fn start_input_injection( &self, index: i32, ___deadline: MonotonicInstant, ) -> Result<InjectionStartInputInjectionResult, Error>

Start injecting the incoming audio for this device, using the audio at index.

Before calling this, use WriteInputAudio to store audio data at the given index.

• request index refers a specific audio_data input record to play on the virtual microphone.

• response error description of failure action to take.

pub fn stop_input_injection( &self, ___deadline: MonotonicInstant, ) -> Result<InjectionStopInputInjectionResult, Error>

Stop injecting audio data.

This stops playing all injected tracks.

This is intended to be called after calling StartInputInjection. If no tracks have been started, or if all started tracks have already completed, then this function will immediately return without error.

• response error description of failure action to take.

Trait Implementations

impl Debug for InjectionSynchronousProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Channel> for InjectionSynchronousProxy

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<InjectionSynchronousProxy> for Handle

fn from(value: InjectionSynchronousProxy) -> Self

Converts to this type from the input type.

impl SynchronousProxy for InjectionSynchronousProxy

type Proxy = InjectionProxy

The async proxy for the same protocol.

type Protocol = InjectionMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.