Tizen Native API  5.5
Capability

The Capability API provides capability information of the StreamRecorder.

Required Header

#include <streamrecorder.h>

Overview

The StreamRecorder Capability API provides functions to obtain capability information of the StreamRecorder.

Functions

int streamrecorder_foreach_supported_file_format (streamrecorder_h recorder, streamrecorder_supported_file_format_cb callback, void *user_data)
 Retrieves all supported file formats by invoking a specific callback for each supported file format.
int streamrecorder_foreach_supported_audio_encoder (streamrecorder_h recorder, streamrecorder_supported_audio_encoder_cb callback, void *user_data)
 Retrieves all supported audio encoders by invoking a specific callback for each supported audio encoder.
int streamrecorder_foreach_supported_video_encoder (streamrecorder_h recorder, streamrecorder_supported_video_encoder_cb callback, void *user_data)
 Retrieves all supported video encoders by invoking a specific callback for each supported video encoder.
int streamrecorder_foreach_supported_video_resolution (streamrecorder_h recorder, streamrecorder_supported_video_resolution_cb foreach_cb, void *user_data)
 Retrieves all supported video resolutions by invoking callback function once for each supported video resolution.

Typedefs

typedef bool(* streamrecorder_supported_video_resolution_cb )(int width, int height, void *user_data)
 Called once for each supported video resolution.
typedef bool(* streamrecorder_supported_file_format_cb )(streamrecorder_file_format_e format, void *user_data)
 Called iteratively to notify about the supported file formats.
typedef bool(* streamrecorder_supported_audio_encoder_cb )(streamrecorder_audio_codec_e codec, void *user_data)
 Called iteratively to notify about the supported audio encoders.
typedef bool(* streamrecorder_supported_video_encoder_cb )(streamrecorder_video_codec_e codec, void *user_data)
 Called iteratively to notify about the supported video encoders.

Typedef Documentation

Called iteratively to notify about the supported audio encoders.

Since :
3.0
Parameters:
[in]codecThe codec of audio encoder
[in]user_dataThe user data passed from the foreach function
Returns:
true to continue with the next iteration of the loop,
otherwise false to break out of the loop
Precondition:
streamrecorder_foreach_supported_audio_encoder() will invoke this callback.
See also:
streamrecorder_foreach_supported_audio_encoder()

Called iteratively to notify about the supported file formats.

Since :
3.0
Parameters:
[in]formatThe format of recording files
[in]user_dataThe user data passed from the foreach function
Returns:
true to continue with the next iteration of the loop,
otherwise false to break out of the loop
Precondition:
streamrecorder_foreach_supported_file_format() will invoke this callback.
See also:
streamrecorder_foreach_supported_file_format()

Called iteratively to notify about the supported video encoders.

Since :
3.0
Parameters:
[in]codecThe codec of video encoder
[in]user_dataThe user data passed from the foreach function
Returns:
true to continue with the next iteration of the loop,
otherwise false to break out of the loop
Precondition:
streamrecorder_foreach_supported_video_encoder() will invoke this callback.
See also:
streamrecorder_foreach_supported_video_encoder()
typedef bool(* streamrecorder_supported_video_resolution_cb)(int width, int height, void *user_data)

Called once for each supported video resolution.

Since :
3.0
Parameters:
[in]widthThe video image width
[in]heightThe video image height
[in]user_dataThe user data passed from the foreach function
Returns:
true to continue with the next iteration of the loop,
otherwise false to break out of the loop
Precondition:
streamrecorder_foreach_supported_video_resolution() will invoke this callback.
See also:
streamrecorder_foreach_supported_video_resolution()

Function Documentation

Retrieves all supported audio encoders by invoking a specific callback for each supported audio encoder.

Since :
3.0
Parameters:
[in]recorderThe handle to the streamrecorder
[in]callbackThe iteration callback
[in]user_dataThe user data to be passed to the callback function
Returns:
0 on success, otherwise a negative error value
Return values:
STREAMRECORDER_ERROR_NONESuccessful
STREAMRECORDER_ERROR_NOT_SUPPORTEDNot supported
STREAMRECORDER_ERROR_INVALID_PARAMETERInvalid parameter
Precondition:
Create a stream recorder handle by calling streamrecorder_create().
Postcondition:
streamrecorder_supported_audio_encoder_cb() will be invoked.
See also:
streamrecorder_create()
streamrecorder_set_audio_encoder()
streamrecorder_get_audio_encoder()
streamrecorder_supported_audio_encoder_cb()

Retrieves all supported file formats by invoking a specific callback for each supported file format.

Since :
3.0
Parameters:
[in]recorderThe handle to the streamrecorder
[in]callbackThe iteration callback
[in]user_dataThe user data to be passed to the callback function
Returns:
0 on success, otherwise a negative error value
Return values:
STREAMRECORDER_ERROR_NONESuccessful
STREAMRECORDER_ERROR_NOT_SUPPORTEDNot supported
STREAMRECORDER_ERROR_INVALID_PARAMETERInvalid parameter
Precondition:
Create a stream recorder handle by calling streamrecorder_create().
Postcondition:
streamrecorder_supported_file_format_cb() will be invoked.
See also:
streamrecorder_create()
streamrecorder_get_file_format()
streamrecorder_set_file_format()
streamrecorder_supported_file_format_cb()

Retrieves all supported video encoders by invoking a specific callback for each supported video encoder.

Since :
3.0
Parameters:
[in]recorderThe handle to the streamrecorder
[in]callbackThe iteration callback
[in]user_dataThe user data to be passed to the callback function
Returns:
0 on success, otherwise a negative error value
Return values:
STREAMRECORDER_ERROR_NONESuccessful
STREAMRECORDER_ERROR_NOT_SUPPORTEDNot supported
STREAMRECORDER_ERROR_INVALID_PARAMETERInvalid parameter
Precondition:
Create a stream recorder handle by calling streamrecorder_create().
Postcondition:
streamrecorder_supported_video_encoder_cb() will be invoked.
See also:
streamrecorder_create()
streamrecorder_set_video_encoder()
streamrecorder_get_video_encoder()
streamrecorder_supported_video_encoder_cb()

Retrieves all supported video resolutions by invoking callback function once for each supported video resolution.

Since :
3.0
Parameters:
[in]recorderThe handle to the streamrecorder
[in]foreach_cbThe callback function to be invoked
[in]user_dataThe user data to be passed to the callback function
Returns:
0 on success, otherwise a negative error value
Return values:
STREAMRECORDER_ERROR_NONESuccessful
STREAMRECORDER_ERROR_NOT_SUPPORTEDNot supported
STREAMRECORDER_ERROR_INVALID_PARAMETERInvalid parameter
Precondition:
Create a stream recorder handle by calling streamrecorder_create().
Postcondition:
This function invokes streamrecorder_supported_video_resolution_cb() repeatedly to retrieve each supported video resolution.
See also:
streamrecorder_create()
streamrecorder_set_video_resolution()
streamrecorder_get_video_resolution()
streamrecorder_supported_video_resolution_cb()