k4a_record_add_custom_subtitle_track()

k4a_result_t k4a_record_add_custom_subtitle_track ( const k4a_record_t  recording_handle, const char *  track_name, const char *  codec_id, const uint8_t *  codec_context, size_t  codec_context_size, const k4a_record_subtitle_settings_t *  track_settings  )

related

Adds custom subtitle tracks to the recording.

Parameters

recording_handle	The handle of a new recording, obtained by k4a_record_create().
track_name	The name of the custom subtitle track to be added.
codec_id	A UTF8 null terminated string containing the codec ID of the track. Some of the existing formats are listed here: https://www.matroska.org/technical/specs/codecid/index.html. The codec ID can also be custom defined by the user. Subtitle codec ID's should start with 'S_'.
codec_context	The codec context is a codec-specific buffer that contains any required codec metadata that is only known to the codec. It is mapped to the matroska 'CodecPrivate' element.
codec_context_size	The size of the codec context buffer.
track_settings	Additional metadata for the subtitle track. If NULL, the default settings will be used.

Returns

K4A_RESULT_SUCCEEDED is returned on success

Remarks

Built-in subtitle tracks like the IMU track will be created automatically when the k4a_record_add_imu_track() API is called. This API can be used to add additional subtitle tracks to save custom data.

Track names must be ALL CAPS and may only contain A-Z, 0-9, '-' and '_'.

All tracks need to be added before the recording header is written.

Call k4a_record_write_custom_track_data() with the same track_name to write data to this track.