Struct RecorderRecordRequest

pub struct RecorderRecordRequest {
    pub source: Option<RecordSource>,
    pub stream_type: Option<AudioStreamType>,
    pub duration: Option<i64>,
    pub canceler: Option<ServerEnd<RecordCancelerMarker>>,
    pub gain_settings: Option<GainSettings>,
    pub buffer_size: Option<u64>,
    pub wav_data: Option<Socket>,
    /* private fields */
}

Fields

source: Option<RecordSource>

The source from which to record the audio.

Required.

stream_type: Option<AudioStreamType>

The stream format in which to record the audio.

Required.

duration: Option<i64>

Duration in nanoseconds to record audio data.

If not specified, Recorder will record and write data to the socket until it receives a stop signal on canceler.

If present, the record request is still cancelable via canceler.

Optional.

canceler: Option<ServerEnd<RecordCancelerMarker>>

Handle to signal when to stop sending data back to the client.

Required.

gain_settings: Option<GainSettings>

Record gain settings.

Only used for the capturer and loopback sources.

Optional.

buffer_size: Option<u64>

Buffer size.

Optional. If not specified, defaults to a size that is enough to hold one second of audio data.

wav_data: Option<Socket>

Sink for audio data.

The captured data here will be written here as a complete WAV file.

Required.

Trait Implementations

impl Debug for RecorderRecordRequest

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

Formats the value using the given formatter.

impl Decode<RecorderRecordRequest, DefaultFuchsiaResourceDialect> for RecorderRecordRequest

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, DefaultFuchsiaResourceDialect>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for RecorderRecordRequest

fn default() -> RecorderRecordRequest

Returns the “default value” for a type.

impl Encode<RecorderRecordRequest, DefaultFuchsiaResourceDialect> for &mut RecorderRecordRequest

unsafe fn encode( self, encoder: &mut Encoder<'_, DefaultFuchsiaResourceDialect>, offset: usize, depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for RecorderRecordRequest

fn eq(&self, other: &RecorderRecordRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ResourceTypeMarker for RecorderRecordRequest

type Borrowed<'a> = &'a mut RecorderRecordRequest

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &mut Self::Owned. There are three cases:

fn take_or_borrow<'a>( value: &'a mut <Self as TypeMarker>::Owned, ) -> Self::Borrowed<'a>

Cheaply converts from &mut Self::Owned to Self::Borrowed. For HandleBased types this is “take” (it returns an owned handle and replaces value with Handle::invalid), and for all other types it is “borrow” (just converts from one reference to another).

impl TypeMarker for RecorderRecordRequest

type Owned = RecorderRecordRequest

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl Standalone<DefaultFuchsiaResourceDialect> for RecorderRecordRequest

impl StructuralPartialEq for RecorderRecordRequest