Trait gstreamer_audio::subclass::prelude::AudioEncoderImpl

pub trait AudioEncoderImpl: AudioEncoderImplExt + ElementImpl {
    // Provided methods
    fn open(&self) -> Result<(), ErrorMessage> { ... }
    fn close(&self) -> Result<(), ErrorMessage> { ... }
    fn start(&self) -> Result<(), ErrorMessage> { ... }
    fn stop(&self) -> Result<(), ErrorMessage> { ... }
    fn set_format(&self, info: &AudioInfo) -> Result<(), LoggableError> { ... }
    fn handle_frame(
        &self,
        buffer: Option<&Buffer>,
    ) -> Result<FlowSuccess, FlowError> { ... }
    fn pre_push(&self, buffer: Buffer) -> Result<Option<Buffer>, FlowError> { ... }
    fn flush(&self) { ... }
    fn negotiate(&self) -> Result<(), LoggableError> { ... }
    fn caps(&self, filter: Option<&Caps>) -> Caps { ... }
    fn sink_event(&self, event: Event) -> bool { ... }
    fn sink_query(&self, query: &mut QueryRef) -> bool { ... }
    fn src_event(&self, event: Event) -> bool { ... }
    fn src_query(&self, query: &mut QueryRef) -> bool { ... }
    fn propose_allocation(
        &self,
        query: &mut Allocation,
    ) -> Result<(), LoggableError> { ... }
    fn decide_allocation(
        &self,
        query: &mut Allocation,
    ) -> Result<(), LoggableError> { ... }
}

Provided Methods

fn open(&self) -> Result<(), ErrorMessage>

Optional. Called when the element changes to GST_STATE_READY. Allows opening external resources.

fn close(&self) -> Result<(), ErrorMessage>

Optional. Called when the element changes to GST_STATE_NULL. Allows closing external resources.

fn start(&self) -> Result<(), ErrorMessage>

Optional. Called when the element starts processing. Allows opening external resources.

fn stop(&self) -> Result<(), ErrorMessage>

Optional. Called when the element stops processing. Allows closing external resources.

fn set_format(&self, info: &AudioInfo) -> Result<(), LoggableError>

Notifies subclass of incoming data format. GstAudioInfo contains the format according to provided caps.

fn handle_frame( &self, buffer: Option<&Buffer>, ) -> Result<FlowSuccess, FlowError>

Provides input samples (or NULL to clear any remaining data) according to directions as configured by the subclass using the API. Input data ref management is performed by base class, subclass should not care or intervene, and input data is only valid until next call to base class, most notably a call to AudioEncoderExt::finish_frame().

fn pre_push(&self, buffer: Buffer) -> Result<Option<Buffer>, FlowError>

Optional. Called just prior to pushing (encoded data) buffer downstream. Subclass has full discretionary access to buffer, and a not OK flow return will abort downstream pushing.

fn flush(&self)

Optional. Instructs subclass to clear any codec caches and discard any pending samples and not yet returned encoded data.

fn negotiate(&self) -> Result<(), LoggableError>

Negotiate with downstream elements to currently configured gst::Caps. Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if negotiate fails.

Returns

true if the negotiation succeeded, else false.

fn caps(&self, filter: Option<&Caps>) -> Caps

fn sink_event(&self, event: Event) -> bool

Optional. Event handler on the sink pad. Subclasses should chain up to the parent implementation to invoke the default handler.

fn sink_query(&self, query: &mut QueryRef) -> bool

Optional. Query handler on the sink pad. This function should return TRUE if the query could be performed. Subclasses should chain up to the parent implementation to invoke the default handler. Since: 1.6

fn src_event(&self, event: Event) -> bool

Optional. Event handler on the src pad. Subclasses should chain up to the parent implementation to invoke the default handler.

fn src_query(&self, query: &mut QueryRef) -> bool

Optional. Query handler on the source pad. This function should return TRUE if the query could be performed. Subclasses should chain up to the parent implementation to invoke the default handler. Since: 1.6

fn propose_allocation( &self, query: &mut Allocation, ) -> Result<(), LoggableError>

Optional. Propose buffer allocation parameters for upstream elements. Subclasses should chain up to the parent implementation to invoke the default handler.

fn decide_allocation(&self, query: &mut Allocation) -> Result<(), LoggableError>

Optional. Setup the allocation parameters for allocating output buffers. The passed in query contains the result of the downstream allocation query. Subclasses should chain up to the parent implementation to invoke the default handler.

Object Safety

This trait is not object safe.

Implementors