k4a_playback_track_get_codec_id()

k4a_buffer_result_t k4a_playback_track_get_codec_id	(	k4a_playback_t	playback_handle,
		const char *	track_name,
		char *	codec_id,
		size_t *	codec_id_size
	)

Gets the codec id string for a particular track.

The codec ID is a string that corresponds to the codec of the track's data. Some of the existing formats are listed here: https://www.matroska.org/technical/specs/codecid/index.html. It can also be custom defined by the user.

Parameters

playback_handle	Handle obtained by k4a_playback_open().
track_name	The track name to read the codec id from.
codec_id	Location to write the codec id. This will be a UTF8 null terminated string. If a NULL buffer is specified, codec_id_size will be set to the size of buffer needed to store the string.
codec_id_size	On input, the size of the codec_id buffer. On output, this is set to the length of the codec_id value (including the null terminator).

Returns

A return of K4A_BUFFER_RESULT_SUCCEEDED means that the codec_id has been filled in. If the buffer is too small the function returns K4A_BUFFER_RESULT_TOO_SMALL and the needed size of the codec_id buffer is returned in the codec_id_size parameter. K4A_BUFFER_RESULT_FAILED is returned if the track_name does not exist. All other failures return K4A_BUFFER_RESULT_FAILED.