k4a_playback_get_track_name()

k4a_buffer_result_t k4a_playback_get_track_name	(	k4a_playback_t	playback_handle,
		size_t	track_index,
		char *	track_name,
		size_t *	track_name_size
	)

Gets the name of a track at a specific index.

Parameters

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

Returns

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

Remarks

When used along with k4a_playback_get_track_count(), this function can be used to enumerate all the available tracks in a playback file. Additionally k4a_playback_track_is_builtin() can be used to filter custom tracks.