Stream list

Detailed Description

Typedefs
typedef struct ed247_internal_stream_list_t *	ed247_stream_list_t
	Stream list identifier.

Functions
LIBED247_EXPORT ed247_status_t	ed247_stream_list_size (ed247_stream_list_t streams, uint32_t *size)
	Get the size of the list. More...
LIBED247_EXPORT ed247_status_t	ed247_stream_list_next (ed247_stream_list_t streams, ed247_stream_t *stream)
	Iterate over a stream identifier list. More...
LIBED247_EXPORT ed247_status_t	ed247_stream_list_free (ed247_stream_list_t streams)
	Free stream list. More...

Function Documentation

LIBED247_EXPORT ed247_status_t ed247_stream_list_size	(	ed247_stream_list_t	streams,
		uint32_t *	size
	)

Get the size of the list.

Parameters

[in]	streams	The stream list
[out]	size	The size of the list

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE

LIBED247_EXPORT ed247_status_t ed247_stream_list_next	(	ed247_stream_list_t	streams,
		ed247_stream_t *	stream
	)

Iterate over a stream identifier list.

A null value is set when the end of the list is reached. Return value is ED247_STATUS_SUCCESS. The next call will return the pointer to the first item of the list.

Parameters

[in,out]	streams	The stream list
[out]	stream	A pointer to the current item in the list.

Return values

ED247_STATUS_SUCCESS	Operation completed successfully even if end of list may be reached
ED247_STATUS_FAILURE	Invalid parameter provided or internal error

LIBED247_EXPORT ed247_status_t ed247_stream_list_free

(

ed247_stream_list_t

streams

)

Free stream list.

Parameters

[in]

streams

The stream list

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE