backchannel.h File Reference

RTSP backchannel (two-way audio) support. More...

#include <compy/droppable.h>
#include <compy/receiver.h>
#include <stdint.h>
#include <compy/priv/compiler_attrs.h>

Include dependency graph for backchannel.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Compy_BackchannelConfig
	Backchannel audio configuration. More...

Typedefs
typedef struct Compy_Backchannel	Compy_Backchannel

Functions
Compy_BackchannelConfig	Compy_BackchannelConfig_default (void) COMPY_PRIV_MUST_USE
	Returns the default backchannel configuration (PCMU, 8000 Hz).
Compy_Backchannel *	Compy_Backchannel_new (Compy_BackchannelConfig config, Compy_AudioReceiver audio_receiver) COMPY_PRIV_MUST_USE
	Creates a new backchannel session.
Compy_RtpReceiver *	Compy_Backchannel_get_receiver (Compy_Backchannel *self) COMPY_PRIV_MUST_USE
	Returns the underlying receiver for feeding incoming data.
Compy_BackchannelConfig	Compy_Backchannel_get_config (const Compy_Backchannel *self) COMPY_PRIV_MUST_USE
	Returns the backchannel configuration (for SDP generation).
	declImplExtern99 (Compy_Droppable, Compy_Backchannel)

Detailed Description

RTSP backchannel (two-way audio) support.

Provides the receive-side session state for backchannel audio. The application advertises backchannel support in SDP with a=recvonly on a separate audio media line, handles SETUP for the backchannel URI, and feeds incoming data to the receiver returned by Compy_Backchannel_get_receiver.

Function Documentation

Compy_Backchannel_get_config()

Compy_BackchannelConfig Compy_Backchannel_get_config

(

const Compy_Backchannel *

self

)

Returns the backchannel configuration (for SDP generation).

Precondition

self != NULL

Compy_Backchannel_get_receiver()

Compy_RtpReceiver * Compy_Backchannel_get_receiver

(

Compy_Backchannel *

self

)

Returns the underlying receiver for feeding incoming data.

The application should call Compy_RtpReceiver_feed on the returned receiver when backchannel RTP data arrives.

Precondition

self != NULL

Compy_Backchannel_new()

Compy_Backchannel * Compy_Backchannel_new	(	Compy_BackchannelConfig	config,
		Compy_AudioReceiver	audio_receiver
	)

Creates a new backchannel session.

Parameters

[in]	config	The audio configuration.
[in]	audio_receiver	The application callback for received audio.

Precondition

audio_receiver.self && audio_receiver.vptr