Trait gstreamer_rtsp_server::prelude::RTSPStreamExt[−][src]

pub trait RTSPStreamExt: 'static {
Show methods
    fn add_multicast_client_address(
        &self, 
        destination: &str, 
        rtp_port: u32, 
        rtcp_port: u32, 
        family: SocketFamily
    ) -> bool;
    fn add_transport<P: IsA<RTSPStreamTransport>>(
        &self, 
        trans: &P
    ) -> Result<(), BoolError>;
    fn address_pool(&self) -> Option<RTSPAddressPool>;
    fn buffer_size(&self) -> u32;
    fn caps(&self) -> Option<Caps>;
    fn control(&self) -> Option<GString>;
    fn current_seqnum(&self) -> u16;
    fn dscp_qos(&self) -> i32;
    fn index(&self) -> u32;
    fn joined_bin(&self) -> Option<Bin>;
    fn max_mcast_ttl(&self) -> u32;
    fn mtu(&self) -> u32;
    fn multicast_address(&self, family: SocketFamily) -> Option<RTSPAddress>;
    fn multicast_client_addresses(&self) -> Option<GString>;
    fn multicast_iface(&self) -> Option<GString>;
    fn profiles(&self) -> RTSPProfile;
    fn protocols(&self) -> RTSPLowerTrans;
    fn pt(&self) -> u32;
    fn publish_clock_mode(&self) -> RTSPPublishClockMode;
    fn is_rate_control(&self) -> bool;
    fn rates(&self) -> Option<(f64, f64)>;
    fn retransmission_pt(&self) -> u32;
    fn retransmission_time(&self) -> ClockTime;
    fn rtcp_multicast_socket(&self, family: SocketFamily) -> Option<Socket>;
    fn rtcp_socket(&self, family: SocketFamily) -> Option<Socket>;
    fn rtp_multicast_socket(&self, family: SocketFamily) -> Option<Socket>;
    fn rtp_socket(&self, family: SocketFamily) -> Option<Socket>;
    fn rtpinfo(&self) -> Option<(u32, u32, u32, ClockTime)>;
    fn rtpsession(&self) -> Option<Object>;
    fn sinkpad(&self) -> Option<Pad>;
    fn srcpad(&self) -> Option<Pad>;
    fn srtp_encoder(&self) -> Option<Element>;
    fn ssrc(&self) -> u32;
    fn is_ulpfec_enabled(&self) -> bool;
    fn ulpfec_percentage(&self) -> u32;
    fn ulpfec_pt(&self) -> u32;
    fn handle_keymgmt(&self, keymgmt: &str) -> bool;
    fn has_control(&self, control: Option<&str>) -> bool;
    fn is_bind_mcast_address(&self) -> bool;
    fn is_blocking(&self) -> bool;
    fn is_client_side(&self) -> bool;
    fn is_complete(&self) -> bool;
    fn is_receiver(&self) -> bool;
    fn is_sender(&self) -> bool;
    fn join_bin<P: IsA<Bin>, Q: IsA<Element>>(
        &self, 
        bin: &P, 
        rtpbin: &Q, 
        state: State
    ) -> Result<(), BoolError>;
    fn leave_bin<P: IsA<Bin>, Q: IsA<Element>>(
        &self, 
        bin: &P, 
        rtpbin: &Q
    ) -> Result<(), BoolError>;
    fn recv_rtcp(&self, buffer: &Buffer) -> Result<FlowSuccess, FlowError>;
    fn recv_rtp(&self, buffer: &Buffer) -> Result<FlowSuccess, FlowError>;
    fn remove_transport<P: IsA<RTSPStreamTransport>>(
        &self, 
        trans: &P
    ) -> Result<(), BoolError>;
    fn request_aux_receiver(&self, sessid: u32) -> Option<Element>;
    fn request_aux_sender(&self, sessid: u32) -> Option<Element>;
    fn request_ulpfec_decoder<P: IsA<Element>>(
        &self, 
        rtpbin: &P, 
        sessid: u32
    ) -> Option<Element>;
    fn request_ulpfec_encoder(&self, sessid: u32) -> Option<Element>;
    fn reserve_address(
        &self, 
        address: &str, 
        port: u32, 
        n_ports: u32, 
        ttl: u32
    ) -> Option<RTSPAddress>;
    fn seekable(&self) -> bool;
    fn set_address_pool<P: IsA<RTSPAddressPool>>(&self, pool: Option<&P>);
    fn set_bind_mcast_address(&self, bind_mcast_addr: bool);
    fn set_blocked(&self, blocked: bool) -> Result<(), BoolError>;
    fn set_buffer_size(&self, size: u32);
    fn set_client_side(&self, client_side: bool);
    fn set_control(&self, control: Option<&str>);
    fn set_dscp_qos(&self, dscp_qos: i32);
    fn set_max_mcast_ttl(&self, ttl: u32) -> bool;
    fn set_mtu(&self, mtu: u32);
    fn set_multicast_iface(&self, multicast_iface: Option<&str>);
    fn set_profiles(&self, profiles: RTSPProfile);
    fn set_protocols(&self, protocols: RTSPLowerTrans);
    fn set_pt_map(&self, pt: u32, caps: &Caps);
    fn set_publish_clock_mode(&self, mode: RTSPPublishClockMode);
    fn set_rate_control(&self, enabled: bool);
    fn set_retransmission_pt(&self, rtx_pt: u32);
    fn set_retransmission_time(&self, time: ClockTime);
    fn set_seqnum_offset(&self, seqnum: u16);
    fn set_ulpfec_percentage(&self, percentage: u32);
    fn set_ulpfec_pt(&self, pt: u32);
    fn transport_filter(
        &self, 
        func: Option<&mut dyn FnMut(&RTSPStream, &RTSPStreamTransport) -> RTSPFilterResult>
    ) -> Vec<RTSPStreamTransport>;
    fn unblock_linked(&self) -> Result<(), BoolError>;
    fn update_crypto(
        &self, 
        ssrc: u32, 
        crypto: Option<&Caps>
    ) -> Result<(), BoolError>;
    fn verify_mcast_ttl(&self, ttl: u32) -> bool;
    fn connect_new_rtcp_encoder<F: Fn(&Self, &Element) + Send + Sync + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_new_rtp_encoder<F: Fn(&Self, &Element) + Send + Sync + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_new_rtp_rtcp_decoder<F: Fn(&Self, &Element) + Send + Sync + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_control_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_profiles_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_protocols_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
}

Trait containing all RTSPStream methods.

Implementors

crate::RTSPStream

Required methods

`fn add_multicast_client_address( &self, destination: &str, rtp_port: u32, rtcp_port: u32, family: SocketFamily ) -> bool`[src]

This is supported on crate feature v1_16 only.

Add multicast client address to stream. At this point, the sockets that will stream RTP and RTCP data to destination are supposed to be allocated.

Returns

true if destination can be addedd and handled by self.

`fn add_transport<P: IsA<RTSPStreamTransport>>( &self, trans: &P ) -> Result<(), BoolError>`[src]

Add the transport in trans to self. The media of self will then also be send to the values configured in trans. Adding the same transport twice will not add it a second time.

self must be joined to a bin.

trans must contain a valid [crate::gst_rtsp::RTSPTransport].

Returns

true if trans was added

`fn address_pool(&self) -> Option<RTSPAddressPool>`[src]

Get the crate::RTSPAddressPool used as the address pool of self.

Returns

the crate::RTSPAddressPool of self. [crate::glib::object::ObjectExt::unref()] after usage.

`fn buffer_size(&self) -> u32`[src]

Get the size of the UDP transmission buffer (in bytes)

Returns

the size of the UDP TX buffer

`fn caps(&self) -> Option<Caps>`[src]

Retrieve the current caps of self.

Returns

the crate::gst::Caps of self. use gst_caps_unref() after usage.

`fn control(&self) -> Option<GString>`[src]

Get the control string to identify this stream.

Returns

the control string. g_free() after usage.

`fn current_seqnum(&self) -> u16`[src]

`fn dscp_qos(&self) -> i32`[src]

Get the configured DSCP QoS in of the outgoing sockets.

Returns

the DSCP QoS value of the outgoing sockets, or -1 if disbled.

`fn index(&self) -> u32`[src]

Get the stream index.

Returns

the stream index.

`fn joined_bin(&self) -> Option<Bin>`[src]

Get the previous joined bin with Self::join_bin() or NULL.

Returns

the joined bin or NULL.

`fn max_mcast_ttl(&self) -> u32`[src]

This is supported on crate feature v1_16 only.

Get the the maximum time-to-live value of outgoing multicast packets.

Returns

the maximum time-to-live value of outgoing multicast packets.

`fn mtu(&self) -> u32`[src]

Get the configured MTU in the payloader of self.

Returns

the MTU of the payloader.

`fn multicast_address(&self, family: SocketFamily) -> Option<RTSPAddress>`[src]

Get the multicast address of self for family. The original crate::RTSPAddress is cached and copy is returned, so freeing the return value won’t release the address from the pool.

Returns

the crate::RTSPAddress of self or None when no address could be allocated. [crate::RTSPAddress::free()] after usage.

`fn multicast_client_addresses(&self) -> Option<GString>`[src]

This is supported on crate feature v1_16 only.

Get all multicast client addresses that RTP data will be sent to

Returns

A comma separated list of host:port pairs with destinations

`fn multicast_iface(&self) -> Option<GString>`[src]

Get the multicast interface used for self.

Returns

the multicast interface for self. g_free() after usage.

`fn profiles(&self) -> RTSPProfile`[src]

Get the allowed profiles of self.

Returns

a crate::gst_rtsp::RTSPProfile

`fn protocols(&self) -> RTSPLowerTrans`[src]

Get the allowed protocols of self.

Returns

a crate::gst_rtsp::RTSPLowerTrans

`fn pt(&self) -> u32`[src]

Get the stream payload type.

Returns

the stream payload type.

`fn publish_clock_mode(&self) -> RTSPPublishClockMode`[src]

Gets if and how the stream clock should be published according to RFC7273.

Returns

The GstRTSPPublishClockMode

`fn is_rate_control(&self) -> bool`[src]

This is supported on crate feature v1_18 only.

Returns

whether self will follow the Rate-Control=no behaviour as specified in the ONVIF replay spec.

`fn rates(&self) -> Option<(f64, f64)>`[src]

This is supported on crate feature v1_18 only.

Retrieve the current rate and/or applied_rate.

Returns

true if rate and/or applied_rate could be determined.

`fn retransmission_pt(&self) -> u32`[src]

Get the payload-type used for retransmission of this stream

Returns

The retransmission PT.

`fn retransmission_time(&self) -> ClockTime`[src]

Get the amount of time to store retransmission data.

Returns

the amount of time to store retransmission data.

`fn rtcp_multicast_socket(&self, family: SocketFamily) -> Option<Socket>`[src]

This is supported on crate feature v1_14 only.

Get the multicast RTCP socket from self for a family.

Returns

the multicast RTCP socket or None if no socket could be allocated for family. Unref after usage

`fn rtcp_socket(&self, family: SocketFamily) -> Option<Socket>`[src]

Get the RTCP socket from self for a family.

self must be joined to a bin.

Returns

the RTCP socket or None if no socket could be allocated for family. Unref after usage

`fn rtp_multicast_socket(&self, family: SocketFamily) -> Option<Socket>`[src]

Get the multicast RTP socket from self for a family.

Returns

the multicast RTP socket or None if no

socket could be allocated for family. Unref after usage

`fn rtp_socket(&self, family: SocketFamily) -> Option<Socket>`[src]

Get the RTP socket from self for a family.

self must be joined to a bin.

Returns

the RTP socket or None if no socket could be allocated for family. Unref after usage

`fn rtpinfo(&self) -> Option<(u32, u32, u32, ClockTime)>`[src]

Retrieve the current rtptime, seq and running-time. This is used to construct a RTPInfo reply header.

Returns

true when rtptime, seq and running-time could be determined.

`fn rtpsession(&self) -> Option<Object>`[src]

Get the RTP session of this stream.

Returns

The RTP session of this stream. Unref after usage.

`fn sinkpad(&self) -> Option<Pad>`[src]

Get the sinkpad associated with self.

Returns

the sinkpad. Unref after usage.

`fn srcpad(&self) -> Option<Pad>`[src]

Get the srcpad associated with self.

Returns

the srcpad. Unref after usage.

`fn srtp_encoder(&self) -> Option<Element>`[src]

Get the SRTP encoder for this stream.

Returns

The SRTP encoder for this stream. Unref after usage.

`fn ssrc(&self) -> u32`[src]

Get the SSRC used by the RTP session of this stream. This function can only be called when self has been joined.

`ssrc`

result ssrc

`fn is_ulpfec_enabled(&self) -> bool`[src]

`fn ulpfec_percentage(&self) -> u32`[src]

This is supported on crate feature v1_16 only.

Returns

the amount of redundancy applied when creating ULPFEC protection packets.

`fn ulpfec_pt(&self) -> u32`[src]

This is supported on crate feature v1_16 only.

Returns

the payload type used for ULPFEC protection packets

`fn handle_keymgmt(&self, keymgmt: &str) -> bool`[src]

This is supported on crate feature v1_16 only.

Parse and handle a KeyMgmt header.

`keymgmt`

a keymgmt header

`fn has_control(&self, control: Option<&str>) -> bool`[src]

Check if self has the control string control.

Returns

true is self has control as the control string

`fn is_bind_mcast_address(&self) -> bool`[src]

This is supported on crate feature v1_16 only.

Check if multicast sockets are configured to be bound to multicast addresses.

Returns

true if multicast sockets are configured to be bound to multicast addresses.

`fn is_blocking(&self) -> bool`[src]

Check if self is blocking on a crate::gst::Buffer.

Returns

true if self is blocking

`fn is_client_side(&self) -> bool`[src]

See Self::set_client_side()

Returns

TRUE if this crate::RTSPStream is client-side.

`fn is_complete(&self) -> bool`[src]

This is supported on crate feature v1_14 only.

Checks whether the stream is complete, contains the receiver and the sender parts. As the stream contains sink(s) element(s), it’s possible to perform seek operations on it.

Returns

true if the stream contains at least one sink element.

`fn is_receiver(&self) -> bool`[src]

This is supported on crate feature v1_14 only.

Checks whether the stream is a receiver.

Returns

true if the stream is a receiver and false otherwise.

`fn is_sender(&self) -> bool`[src]

This is supported on crate feature v1_14 only.

Checks whether the stream is a sender.

Returns

true if the stream is a sender and false otherwise.

`fn join_bin<P: IsA<Bin>, Q: IsA<Element>>( &self, bin: &P, rtpbin: &Q, state: State ) -> Result<(), BoolError>`[src]

Join the crate::gst::Bin bin that contains the element rtpbin.

self will link to rtpbin, which must be inside bin. The elements added to bin will be set to the state given in state.

Returns

true on success.

`fn leave_bin<P: IsA<Bin>, Q: IsA<Element>>( &self, bin: &P, rtpbin: &Q ) -> Result<(), BoolError>`[src]

Remove the elements of self from bin.

Returns

true on success.

`fn recv_rtcp(&self, buffer: &Buffer) -> Result<FlowSuccess, FlowError>`[src]

Handle an RTCP buffer for the stream. This method is usually called when a message has been received from a client using the TCP transport.

This function takes ownership of buffer.

Returns

a GstFlowReturn.

`fn recv_rtp(&self, buffer: &Buffer) -> Result<FlowSuccess, FlowError>`[src]

Handle an RTP buffer for the stream. This method is usually called when a message has been received from a client using the TCP transport.

This function takes ownership of buffer.

Returns

a GstFlowReturn.

`fn remove_transport<P: IsA<RTSPStreamTransport>>( &self, trans: &P ) -> Result<(), BoolError>`[src]

Remove the transport in trans from self. The media of self will not be sent to the values configured in trans.

self must be joined to a bin.

trans must contain a valid [crate::gst_rtsp::RTSPTransport].

Returns

true if trans was removed

`fn request_aux_receiver(&self, sessid: u32) -> Option<Element>`[src]

This is supported on crate feature v1_16 only.

Creating a rtxreceive bin

Returns

a crate::gst::Element.

`fn request_aux_sender(&self, sessid: u32) -> Option<Element>`[src]

Creating a rtxsend bin

Returns

a crate::gst::Element.

`fn request_ulpfec_decoder<P: IsA<Element>>( &self, rtpbin: &P, sessid: u32 ) -> Option<Element>`[src]

This is supported on crate feature v1_16 only.

Creating a rtpulpfecdec element

Returns

a crate::gst::Element.

`fn request_ulpfec_encoder(&self, sessid: u32) -> Option<Element>`[src]

This is supported on crate feature v1_16 only.

Creating a rtpulpfecenc element

Returns

a crate::gst::Element.

`fn reserve_address( &self, address: &str, port: u32, n_ports: u32, ttl: u32 ) -> Option<RTSPAddress>`[src]

Reserve address and port as the address and port of self. The original crate::RTSPAddress is cached and copy is returned, so freeing the return value won’t release the address from the pool.

Returns

the crate::RTSPAddress of self or None when the address could not be reserved. [crate::RTSPAddress::free()] after usage.

`fn seekable(&self) -> bool`[src]

This is supported on crate feature v1_14 only.

Checks whether the individual self is seekable.

Returns

true if self is seekable, else false.

`fn set_address_pool<P: IsA<RTSPAddressPool>>(&self, pool: Option<&P>)`[src]

configure pool to be used as the address pool of self.

`pool`

a crate::RTSPAddressPool

`fn set_bind_mcast_address(&self, bind_mcast_addr: bool)`[src]

This is supported on crate feature v1_16 only.

Decide whether the multicast socket should be bound to a multicast address or INADDR_ANY.

`bind_mcast_addr`

the new value

`fn set_blocked(&self, blocked: bool) -> Result<(), BoolError>`[src]

Blocks or unblocks the dataflow on self.

`blocked`

boolean indicating we should block or unblock

Returns

true on success

`fn set_buffer_size(&self, size: u32)`[src]

Set the size of the UDP transmission buffer (in bytes) Needs to be set before the stream is joined to a bin.

Sets the crate::RTSPStream as a ‘client side’ stream - used for sending streams to an RTSP server via RECORD. This has the practical effect of changing which UDP port numbers are used when setting up the local side of the stream sending to be either the ‘server’ or ‘client’ pair of a configured UDP transport.

`client_side`

TRUE if this crate::RTSPStream is running on the ‘client’ side of an RTSP connection.

`fn set_control(&self, control: Option<&str>)`[src]

Set the control string in self.

`control`

a control string

`fn set_dscp_qos(&self, dscp_qos: i32)`[src]

Configure the dscp qos of the outgoing sockets to dscp_qos.

`dscp_qos`

a new dscp qos value (0-63, or -1 to disable)

`fn set_max_mcast_ttl(&self, ttl: u32) -> bool`[src]

This is supported on crate feature v1_16 only.

Set the maximum time-to-live value of outgoing multicast packets.

`ttl`

the new multicast ttl value

Returns

true if the requested ttl has been set successfully.

`fn set_mtu(&self, mtu: u32)`[src]

Configure the mtu in the payloader of self to mtu.

`mtu`

a new MTU

`fn set_multicast_iface(&self, multicast_iface: Option<&str>)`[src]

configure multicast_iface to be used for self.

`multicast_iface`

a multicast interface name

`fn set_profiles(&self, profiles: RTSPProfile)`[src]

Configure the allowed profiles for self.

`profiles`

the new profiles

`fn set_protocols(&self, protocols: RTSPLowerTrans)`[src]

Configure the allowed lower transport for self.

`protocols`

the new flags

`fn set_pt_map(&self, pt: u32, caps: &Caps)`[src]

Configure a pt map between pt and caps.

`pt`

the pt

`caps`

a crate::gst::Caps

`fn set_publish_clock_mode(&self, mode: RTSPPublishClockMode)`[src]

Sets if and how the stream clock should be published according to RFC7273.

`mode`

the clock publish mode

`fn set_rate_control(&self, enabled: bool)`[src]

This is supported on crate feature v1_18 only.

Define whether self will follow the Rate-Control=no behaviour as specified in the ONVIF replay spec.

`fn set_retransmission_pt(&self, rtx_pt: u32)`[src]

Set the payload type (pt) for retransmission of this stream.

`rtx_pt`

a guint

`fn set_retransmission_time(&self, time: ClockTime)`[src]

Set the amount of time to store retransmission packets.

`time`

a crate::gst::ClockTime

`fn set_seqnum_offset(&self, seqnum: u16)`[src]

`fn set_ulpfec_percentage(&self, percentage: u32)`[src]

This is supported on crate feature v1_16 only.

Sets the amount of redundancy to apply when creating ULPFEC protection packets.

`fn set_ulpfec_pt(&self, pt: u32)`[src]

This is supported on crate feature v1_16 only.

Set the payload type to be used for ULPFEC protection packets

`fn transport_filter( &self, func: Option<&mut dyn FnMut(&RTSPStream, &RTSPStreamTransport) -> RTSPFilterResult> ) -> Vec<RTSPStreamTransport>`[src]

Call func for each transport managed by self. The result value of func determines what happens to the transport. func will be called with self locked so no further actions on self can be performed from func.

If func returns crate::RTSPFilterResult::Remove, the transport will be removed from self.

If func returns crate::RTSPFilterResult::Keep, the transport will remain in self.

If func returns crate::RTSPFilterResult::Ref, the transport will remain in self but will also be added with an additional ref to the result [crate::glib::List] of this function..

When func is None, crate::RTSPFilterResult::Ref will be assumed for each transport.

`func`

a callback

`user_data`

user data passed to func

Returns

a [crate::glib::List] with all transports for which func returned crate::RTSPFilterResult::Ref. After usage, each element in the [crate::glib::List] should be unreffed before the list is freed.

`fn unblock_linked(&self) -> Result<(), BoolError>`[src]

`fn update_crypto( &self, ssrc: u32, crypto: Option<&Caps> ) -> Result<(), BoolError>`[src]

Update the new crypto information for ssrc in self. If information for ssrc did not exist, it will be added. If information for ssrc existed, it will be replaced. If crypto is None, it will be removed from self.