Tizen Native API
7.0
|
The Attributes API provides functions to fetch StreamRecorder attributes.
Required Header
#include <streamrecorder.h>
Overview
The StreamRecorder Attributes API provides functions to get/set basic StreamRecorder attributes.
With the StreamRecorder Attributes API you are able to set and get StreamRecorder attributes like:
- File name
- File format
- Audio encoder
- Video encoder
- Recording size limit
- Recording time limit
- Audio samplerate
- Audio encoder bitrate
- Video encoder bitrate
- Audio channel
Functions | |
int | streamrecorder_set_filename (streamrecorder_h recorder, const char *path) TIZEN_DEPRECATED_API |
Sets the file path to record. | |
int | streamrecorder_get_filename (streamrecorder_h recorder, char **path) TIZEN_DEPRECATED_API |
Gets the file path to record. | |
int | streamrecorder_set_file_format (streamrecorder_h recorder, streamrecorder_file_format_e format) TIZEN_DEPRECATED_API |
Sets the file format for recording media stream. | |
int | streamrecorder_get_file_format (streamrecorder_h recorder, streamrecorder_file_format_e *format) TIZEN_DEPRECATED_API |
Gets the file format for recording media stream. | |
int | streamrecorder_set_audio_encoder (streamrecorder_h recorder, streamrecorder_audio_codec_e codec) TIZEN_DEPRECATED_API |
Sets the audio codec for encoding an audio stream. | |
int | streamrecorder_get_audio_encoder (streamrecorder_h recorder, streamrecorder_audio_codec_e *codec) TIZEN_DEPRECATED_API |
Gets the audio codec for encoding an audio stream. | |
int | streamrecorder_set_video_resolution (streamrecorder_h recorder, int width, int height) TIZEN_DEPRECATED_API |
Sets the resolution of the video recording. | |
int | streamrecorder_get_video_resolution (streamrecorder_h recorder, int *width, int *height) TIZEN_DEPRECATED_API |
Gets the resolution of the video recording. | |
int | streamrecorder_set_video_encoder (streamrecorder_h recorder, streamrecorder_video_codec_e codec) TIZEN_DEPRECATED_API |
Sets the video codec for encoding video stream. | |
int | streamrecorder_get_video_encoder (streamrecorder_h recorder, streamrecorder_video_codec_e *codec) TIZEN_DEPRECATED_API |
Gets the video codec for encoding video stream. | |
int | streamrecorder_set_video_framerate (streamrecorder_h recorder, int framerate) TIZEN_DEPRECATED_API |
Sets the recording frame rate. | |
int | streamrecorder_get_video_framerate (streamrecorder_h recorder, int *framerate) TIZEN_DEPRECATED_API |
Gets the recording frame rate. | |
int | streamrecorder_set_video_source_format (streamrecorder_h recorder, streamrecorder_video_source_format_e format) TIZEN_DEPRECATED_API |
Sets the video source format. | |
int | streamrecorder_get_video_source_format (streamrecorder_h recorder, streamrecorder_video_source_format_e *format) TIZEN_DEPRECATED_API |
Gets the video source format. | |
int | streamrecorder_set_recording_limit (streamrecorder_h recorder, streamrecorder_recording_limit_type_e type, int limit) TIZEN_DEPRECATED_API |
Sets the maximum size of a recording file. | |
int | streamrecorder_get_recording_limit (streamrecorder_h recorder, streamrecorder_recording_limit_type_e type, int *limit) TIZEN_DEPRECATED_API |
Gets the maximum size of a recording file. | |
int | streamrecorder_set_audio_samplerate (streamrecorder_h recorder, int samplerate) TIZEN_DEPRECATED_API |
Sets the sampling rate of an audio stream. | |
int | streamrecorder_get_audio_samplerate (streamrecorder_h recorder, int *samplerate) TIZEN_DEPRECATED_API |
Gets the sampling rate of an audio stream. | |
int | streamrecorder_set_audio_encoder_bitrate (streamrecorder_h recorder, int bitrate) TIZEN_DEPRECATED_API |
Sets the bitrate of an audio encoder. | |
int | streamrecorder_set_video_encoder_bitrate (streamrecorder_h recorder, int bitrate) TIZEN_DEPRECATED_API |
Sets the bitrate of a video encoder. | |
int | streamrecorder_get_audio_encoder_bitrate (streamrecorder_h recorder, int *bitrate) TIZEN_DEPRECATED_API |
Gets the bitrate of an audio encoder. | |
int | streamrecorder_get_video_encoder_bitrate (streamrecorder_h recorder, int *bitrate) TIZEN_DEPRECATED_API |
Gets the bitrate of a video encoder. | |
int | streamrecorder_set_audio_channel (streamrecorder_h recorder, int channel_count) TIZEN_DEPRECATED_API |
Sets the number of the audio channel. | |
int | streamrecorder_get_audio_channel (streamrecorder_h recorder, int *channel_count) TIZEN_DEPRECATED_API |
Gets the number of the audio channel. | |
int | streamrecorder_set_mode (streamrecorder_h recorder, streamrecorder_mode_e mode) TIZEN_DEPRECATED_API |
Sets the recording mode. | |
int | streamrecorder_get_mode (streamrecorder_h recorder, streamrecorder_mode_e *mode) TIZEN_DEPRECATED_API |
Gets the recording mode. |
Function Documentation
int streamrecorder_get_audio_channel | ( | streamrecorder_h | recorder, |
int * | channel_count | ||
) |
Gets the number of the audio channel.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [out] channel_count The number of the audio channel
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
- The streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_get_audio_encoder | ( | streamrecorder_h | recorder, |
streamrecorder_audio_codec_e * | codec | ||
) |
Gets the audio codec for encoding an audio stream.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [out] codec The audio codec
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
- The streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_get_audio_encoder_bitrate | ( | streamrecorder_h | recorder, |
int * | bitrate | ||
) |
Gets the bitrate of an audio encoder.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [out] bitrate The bitrate in bits per second
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
- The streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_get_audio_samplerate | ( | streamrecorder_h | recorder, |
int * | samplerate | ||
) |
Gets the sampling rate of an audio stream.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [out] samplerate The sample rate in Hertz
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
- The streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_get_file_format | ( | streamrecorder_h | recorder, |
streamrecorder_file_format_e * | format | ||
) |
Gets the file format for recording media stream.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [out] format The media file format
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
- The streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_get_filename | ( | streamrecorder_h | recorder, |
char ** | path | ||
) |
Gets the file path to record.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Remarks:
- You must release path using free().
- Parameters:
-
[in] recorder The handle to the streamrecorder [out] path The recording file path
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter streamrecorder_enable_source_buffer() should be invoked before this function.
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
int streamrecorder_get_mode | ( | streamrecorder_h | recorder, |
streamrecorder_mode_e * | mode | ||
) |
Gets the recording mode.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 6.0
- Remarks:
- STREAMRECORDER_MODE_STREAM_BUFFER indicates recording with media buffer.
STREAMRECORDER_MODE_DEVICE_LOOPBACK indicates recording the device's own screen (display) and audio.
- Parameters:
-
[in] recorder The handle to the streamrecorder [out] mode The recording mode
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state
- Precondition:
- The streamrecorder state must be STREAMRECORDER_STATE_CREATED.
int streamrecorder_get_recording_limit | ( | streamrecorder_h | recorder, |
streamrecorder_recording_limit_type_e | type, | ||
int * | limit | ||
) |
Gets the maximum size of a recording file.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] type The recording limit type [out] limit If limit type is STREAMRECORDER_RECORDING_LIMIT_TYPE_SIZE, the limit value is the maximum size of the recording file(KB),
otherwise limit value is the maximum time of the recording file (in seconds)
0
means unlimited recording size or time.
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
- The streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_get_video_encoder | ( | streamrecorder_h | recorder, |
streamrecorder_video_codec_e * | codec | ||
) |
Gets the video codec for encoding video stream.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [out] codec The video codec
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
- The streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_get_video_encoder_bitrate | ( | streamrecorder_h | recorder, |
int * | bitrate | ||
) |
Gets the bitrate of a video encoder.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [out] bitrate The bitrate in bits per second
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
- The streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_get_video_framerate | ( | streamrecorder_h | recorder, |
int * | framerate | ||
) |
Gets the recording frame rate.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the camera [out] framerate The frame rate for recording that already is set
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
int streamrecorder_get_video_resolution | ( | streamrecorder_h | recorder, |
int * | width, | ||
int * | height | ||
) |
Gets the resolution of the video recording.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [out] width The video width [out] height The video height
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
- The streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_get_video_source_format | ( | streamrecorder_h | recorder, |
streamrecorder_video_source_format_e * | format | ||
) |
Gets the video source format.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Remarks:
- This function should be called before prepared state.
- Parameters:
-
[in] recorder The handle to the streamrecorder [out] format The color type of video source that already is set
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
int streamrecorder_set_audio_channel | ( | streamrecorder_h | recorder, |
int | channel_count | ||
) |
Sets the number of the audio channel.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Remarks:
- This attribute is applied only in STREAMRECORDER_STATE_CREATED state.
For mono recording, setting channel to1
.
For stereo recording, setting channel to2
.
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] channel_count The number of the audio channel
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
-
The streamrecorder state must be STREAMRECORDER_STATE_CREATED.
streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_set_audio_encoder | ( | streamrecorder_h | recorder, |
streamrecorder_audio_codec_e | codec | ||
) |
Sets the audio codec for encoding an audio stream.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Remarks:
- You can get available audio encoders by using streamrecorder_foreach_supported_audio_encoder().
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] codec The audio codec
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state STREAMRECORDER_ERROR_INVALID_OPERATION Invalid operation
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
-
The streamrecorder state must be STREAMRECORDER_STATE_CREATED.
streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_set_audio_encoder_bitrate | ( | streamrecorder_h | recorder, |
int | bitrate | ||
) |
Sets the bitrate of an audio encoder.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] bitrate The bitrate (for mms : 12200[bps], normal : 288000[bps])
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
-
The streamrecorder state must be STREAMRECORDER_STATE_CREATED.
streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_set_audio_samplerate | ( | streamrecorder_h | recorder, |
int | samplerate | ||
) |
Sets the sampling rate of an audio stream.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] samplerate The sample rate in Hertz
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
-
The streamrecorder state must be STREAMRECORDER_STATE_CREATED.
streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_set_file_format | ( | streamrecorder_h | recorder, |
streamrecorder_file_format_e | format | ||
) |
Sets the file format for recording media stream.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] format The media file format
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state STREAMRECORDER_ERROR_INVALID_OPERATION Invalid operation
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
-
The streamrecorder state must be STREAMRECORDER_STATE_CREATED.
streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_set_filename | ( | streamrecorder_h | recorder, |
const char * | path | ||
) |
Sets the file path to record.
- Deprecated:
- Deprecated since 7.0.
This function sets file path which defines where newly recorded data should be stored.
- Since :
- 3.0
- Remarks:
- If the same file already exists in the file system, then old file will be overwritten.
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] path The recording file path
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
-
The streamrecorder state must be STREAMRECORDER_STATE_CREATED.
streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_set_mode | ( | streamrecorder_h | recorder, |
streamrecorder_mode_e | mode | ||
) |
Sets the recording mode.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 6.0
- Remarks:
- This attribute can be set only in the STREAMRECORDER_STATE_CREATED state.
To record with media buffer, set the mode to STREAMRECORDER_MODE_STREAM_BUFFER.
To record with the device's own screen (display) and audio, set the mode to STREAMRECORDER_MODE_DEVICE_LOOPBACK.
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] mode The recording mode
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state
- Precondition:
- The streamrecorder state must be STREAMRECORDER_STATE_CREATED.
int streamrecorder_set_recording_limit | ( | streamrecorder_h | recorder, |
streamrecorder_recording_limit_type_e | type, | ||
int | limit | ||
) |
Sets the maximum size of a recording file.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Remarks:
- After reaching the limitation, the recording data is discarded and not written in the recording file.
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] type The recording limit type [in] limit If limit type is STREAMRECORDER_RECORDING_LIMIT_TYPE_SIZE, the limit value is the maximum size of the recording file(KB),
otherwise limit value is the maximum time of the recording file (in seconds)
0
means unlimited recording size or time.
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
-
The streamrecorder state must be STREAMRECORDER_STATE_CREATED.
streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_set_video_encoder | ( | streamrecorder_h | recorder, |
streamrecorder_video_codec_e | codec | ||
) |
Sets the video codec for encoding video stream.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Remarks:
- You can get available video encoders by using recorder_foreach_supported_video_encoder().
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] codec The video codec
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
-
The streamrecorder state must be STREAMRECORDER_STATE_CREATED.
streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_set_video_encoder_bitrate | ( | streamrecorder_h | recorder, |
int | bitrate | ||
) |
Sets the bitrate of a video encoder.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] bitrate The bitrate in bits per second
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
-
The streamrecorder state must be STREAMRECORDER_STATE_CREATED.
streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_set_video_framerate | ( | streamrecorder_h | recorder, |
int | framerate | ||
) |
Sets the recording frame rate.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Remarks:
- This function should be called before prepared state.
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] framerate The frame rate for recording
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
int streamrecorder_set_video_resolution | ( | streamrecorder_h | recorder, |
int | width, | ||
int | height | ||
) |
Sets the resolution of the video recording.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Remarks:
- This function should be called before recording (streamrecorder_start()).
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] width The input width [in] height The input height
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().
-
The streamrecorder state must be STREAMRECORDER_STATE_CREATED.
streamrecorder_enable_source_buffer() should be invoked before this function.
int streamrecorder_set_video_source_format | ( | streamrecorder_h | recorder, |
streamrecorder_video_source_format_e | format | ||
) |
Sets the video source format.
- Deprecated:
- Deprecated since 7.0.
- Since :
- 3.0
- Remarks:
- This function should be called before prepared state.
- Parameters:
-
[in] recorder The handle to the streamrecorder [in] format The color type of video source
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
STREAMRECORDER_ERROR_NONE Successful STREAMRECORDER_ERROR_NOT_SUPPORTED Not supported STREAMRECORDER_ERROR_INVALID_PARAMETER Invalid parameter STREAMRECORDER_ERROR_INVALID_STATE Invalid state
- Precondition:
- Create a stream recorder handle by calling streamrecorder_create().