Struct CaptureSynchronousProxy

pub struct CaptureSynchronousProxy { /* private fields */ }

Implementations

impl CaptureSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<CaptureEvent, 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 start_output_capture( &self, ___deadline: MonotonicInstant, ) -> Result<CaptureStartOutputCaptureResult, Error>

Start capturing the outgoing audio for this device.

A virtual output device receives what would have played through the device’s speakers. This method reads from that virtual output device, into an internal buffer.

After calling this method, use StopOutputCapture to stop recording output and then GetOutputAudio to retrieve this captured audio.

• response error description of failure action to take.

pub fn stop_output_capture( &self, ___deadline: MonotonicInstant, ) -> Result<CaptureStopOutputCaptureResult, Error>

Stop capturing the outgoing audio for this device.

This method will succeed even if no output capture has been started.

After calling this method, use GetOutputAudio to retrieve the captured audio from the virtual device’s internal buffer and return it to the client.

• response error description of failure action to take.

pub fn get_output_audio( &self, ___deadline: MonotonicInstant, ) -> Result<CaptureGetOutputAudioResult, Error>

Extract the captured outgoing audio data through a socket.

The socket is closed once it is fully drained.

User should have first called StartOutputCapture and StopOutputCapture. This method will return the contents of the internal buffer that was populated between the calls to those two methods.

Audio output format is 2-channel 48kHz 16-bit PCM.

• request audio_reader socket where full captured audio data will be streamed.

• response error description of failure action to take.

Trait Implementations

impl Debug for CaptureSynchronousProxy

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

Formats the value using the given formatter.

impl From<CaptureSynchronousProxy> for Handle

fn from(value: CaptureSynchronousProxy) -> Self

Converts to this type from the input type.

impl From<Channel> for CaptureSynchronousProxy

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl SynchronousProxy for CaptureSynchronousProxy

type Proxy = CaptureProxy

The async proxy for the same protocol.

type Protocol = CaptureMarker

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.