Channel

Detailed Description

Modules
	Channel list

Typedefs
typedef struct ed247_internal_channel_t *	ed247_channel_t
	Channel identifier.

Functions
LIBED247_EXPORT ed247_status_t	ed247_channel_get_stream_list (ed247_channel_t channel, ed247_stream_list_t *streams)
	Retrieve all the streams of the channel. More...
LIBED247_EXPORT ed247_status_t	ed247_channel_find_streams (ed247_channel_t channel, const char *regex_name, ed247_stream_list_t *streams)
	Find all streams of the channel whose names match regex_name. More...
LIBED247_EXPORT ed247_status_t	ed247_channel_get_stream (ed247_channel_t channel, const char *name, ed247_stream_t *stream)
	get a channel stream. More...
LIBED247_EXPORT ed247_status_t	ed247_channel_set_user_data (ed247_channel_t channel, void *user_data)
	Assign user data to the channel. More...
LIBED247_EXPORT ed247_status_t	ed247_channel_get_user_data (ed247_channel_t channel, void **user_data)
	Retrieve user data assigned to the channel. More...
LIBED247_EXPORT const char *	ed247_channel_get_name (ed247_channel_t channel)
LIBED247_EXPORT const char *	ed247_channel_get_comment (ed247_channel_t channel)
LIBED247_EXPORT ed247_standard_t	ed247_channel_get_frame_standard_revision (ed247_channel_t channel)

Function Documentation

LIBED247_EXPORT ed247_status_t ed247_channel_get_stream_list	(	ed247_channel_t	channel,
		ed247_stream_list_t *	streams
	)

Retrieve all the streams of the channel.

The lifespan of returned streams is the same as the context, but you can safely call ed247_stream_list_free().

Parameters

[in]	channel	The channel identifier
[out]	streams	List of the streams

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE

Here is the caller graph for this function:

LIBED247_EXPORT ed247_status_t ed247_channel_find_streams	(	ed247_channel_t	channel,
		const char *	regex_name,
		ed247_stream_list_t *	streams
	)

Find all streams of the channel whose names match regex_name.

regex_name shall follow the ECMAScript grammar.
This function allocates streams. It has to be freed with ed247_stream_list_free().
If you know exact stream names, use ed247_get_stream() instead which is really faster and malloc-free.
If you want all channel streams, use ed247_channel_get_stream_list() instead which is really faster and malloc-free.

Parameters

[in]	channel	The channel identifier
[in]	regex_name	The regular expression for name matching. If null, assume '.*'.
[out]	streams	The list of the streams. If no value, set to null.

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE	The stream list is empty

Note

The regular expressions are not implemented in gcc4.8.x (default linux), do not use complex requests.

Here is the caller graph for this function:

LIBED247_EXPORT ed247_status_t ed247_channel_get_stream	(	ed247_channel_t	channel,
		const char *	name,
		ed247_stream_t *	stream
	)

get a channel stream.

Parameters

[in]	channel	The channel identifier
[in]	name	The name of the stream.
[out]	stream	The stream identifier.

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE	The stream list is empty

Here is the caller graph for this function:

LIBED247_EXPORT ed247_status_t ed247_channel_set_user_data	(	ed247_channel_t	channel,
		void *	user_data
	)

Assign user data to the channel.

Memory has to be free by the user.

Parameters

[in]	channel	The channel identifier
[in]	user_data	Pointer to user data

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE

LIBED247_EXPORT ed247_status_t ed247_channel_get_user_data	(	ed247_channel_t	channel,
		void **	user_data
	)

Retrieve user data assigned to the channel.

Parameters

[in]	channel	The channel identifier
[out]	user_data	Pointer to host pointer to user data

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE