VLC  4.0.0-dev
vlc_rtp_pt_operations Struct Reference

RTP payload type operations. More...

Data Fields

void(* release )(struct vlc_rtp_pt *pt)
 Releases the payload type. More...
 
void *(* init )(struct vlc_rtp_pt *pt)
 Starts using a payload type. More...
 
void(* destroy )(struct vlc_rtp_pt *pt, void *data)
 Stops using a payload type. More...
 
void(* decode )(struct vlc_rtp_pt *pt, void *data, block_t *block, const struct vlc_rtp_pktinfo *restrict info)
 Processes a data payload. More...
 

Detailed Description

RTP payload type operations.

This structures contains the callbacks provided by an RTP payload type (vlc_rtp_pt).

Field Documentation

◆ decode

void(* vlc_rtp_pt_operations::decode) (struct vlc_rtp_pt *pt, void *data, block_t *block, const struct vlc_rtp_pktinfo *restrict info)

Processes a data payload.

Parameters
ptRTP payload type of the payload
datadata pointer returned by init()
blockpayload of a received RTP packet
infoRTP packet header infos

Referenced by vlc_rtp_pt_decode().

◆ destroy

void(* vlc_rtp_pt_operations::destroy) (struct vlc_rtp_pt *pt, void *data)

Stops using a payload type.

This optional callback deinitialises per-source resources.

Parameters
ptRTP payload type to relinquish
datadata pointer returned by init()

Referenced by vlc_rtp_pt_end().

◆ init

void*(* vlc_rtp_pt_operations::init) (struct vlc_rtp_pt *pt)

Starts using a payload type.

This required callback initialises per-source resources for the payload type, such as an elementary stream output.

Note
There may be multiple RTP sources using the same payload type concurrently within single given RTP session. This callback is invoked for each source.
Parameters
ptRTP payload type being taken into use
Returns
a data pointer for decode() and destroy() callbacks

Referenced by vlc_rtp_pt_begin().

◆ release

void(* vlc_rtp_pt_operations::release) (struct vlc_rtp_pt *pt)

Releases the payload type.

This optional callback releases any resources associated with the payload format, such as copies of the payload format parameters.

Parameters
ptRTP payload type that is being released

Referenced by vlc_rtp_pt_release().


The documentation for this struct was generated from the following file: