Call-control

Functions
LinphoneRecorder *	linphone_recorder_new (LinphoneCore *core, const LinphoneRecorderParams *params)
LinphoneRecorder *	linphone_recorder_ref (LinphoneRecorder *recorder)
void	linphone_recorder_unref (LinphoneRecorder *recorder)
LinphoneStatus	linphone_recorder_open (LinphoneRecorder *recorder, const char *file)
void	linphone_recorder_close (LinphoneRecorder *recorder)
const char *	linphone_recorder_get_file (const LinphoneRecorder *recorder)
LinphoneStatus	linphone_recorder_start (LinphoneRecorder *recorder)
LinphoneStatus	linphone_recorder_pause (LinphoneRecorder *recorder)
LinphoneRecorderState	linphone_recorder_get_state (const LinphoneRecorder *recorder)
int	linphone_recorder_get_duration (const LinphoneRecorder *recorder)
float	linphone_recorder_get_capture_volume (const LinphoneRecorder *recorder)
LinphoneContent *	linphone_recorder_create_content (LinphoneRecorder *recorder)
void	linphone_recorder_set_params (LinphoneRecorder *recorder, LinphoneRecorderParams *params)
const LinphoneRecorderParams *	linphone_recorder_get_params (const LinphoneRecorder *recorder)
void	linphone_recorder_set_user_data (LinphoneRecorder *recorder, void *user_data)
void *	linphone_recorder_get_user_data (const LinphoneRecorder *recorder)
LinphoneRecorderParams *	linphone_recorder_params_new (void)
LinphoneRecorderParams *	linphone_recorder_params_clone (const LinphoneRecorderParams *params)
LinphoneRecorderParams *	linphone_recorder_params_ref (LinphoneRecorderParams *params)
void	linphone_recorder_params_unref (LinphoneRecorderParams *params)
void	linphone_recorder_params_set_audio_device (LinphoneRecorderParams *params, const LinphoneAudioDevice *device)
const LinphoneAudioDevice *	linphone_recorder_params_get_audio_device (const LinphoneRecorderParams *params)
void	linphone_recorder_params_set_webcam_name (LinphoneRecorderParams *params, const char *webcam_name)
const char *	linphone_recorder_params_get_webcam_name (const LinphoneRecorderParams *params)
void	linphone_recorder_params_set_video_codec (LinphoneRecorderParams *params, const char *video_codec)
const char *	linphone_recorder_params_get_video_codec (const LinphoneRecorderParams *params)
void	linphone_recorder_params_set_file_format (LinphoneRecorderParams *params, LinphoneMediaFileFormat format)
LinphoneMediaFileFormat	linphone_recorder_params_get_file_format (const LinphoneRecorderParams *params)
void	linphone_recorder_params_set_window_id (LinphoneRecorderParams *params, void *window_id)
void *	linphone_recorder_params_get_window_id (const LinphoneRecorderParams *params)

Detailed Description

Function Documentation

void linphone_recorder_close

(

LinphoneRecorder *

recorder

)

Closes the opened file.

Parameters

recorder

The LinphoneRecorder object.

LinphoneContent* linphone_recorder_create_content

(

LinphoneRecorder *

recorder

)

Create a LinphoneContent object from the recording, for example to send it within a LinphoneChatMessage.

Warning

Recorder must be in Closed state!

Parameters

recorder

The LinphoneRecorder object.

Returns

the LinphoneContent matching the recording, or NULL.

float linphone_recorder_get_capture_volume

(

const LinphoneRecorder *

recorder

)

Get linear volume when capturing audio.

Parameters

recorder

The LinphoneRecorder object.

Returns

Linear volume.

int linphone_recorder_get_duration

(

const LinphoneRecorder *

recorder

)

Gets the duration of the recording.

Parameters

recorder

The LinphoneRecorder object.

Returns

the duration of the recording, in milliseconds.

const char* linphone_recorder_get_file

(

const LinphoneRecorder *

recorder

)

Gets the file used for recording.

Parameters

recorder

The LinphoneRecorder object.

Returns

the file used for the recording if any.

const LinphoneRecorderParams* linphone_recorder_get_params

(

const LinphoneRecorder *

recorder

)

Retrieves the LinphoneRecorderParams object.

Parameters

recorder

The LinphoneRecorder object.

Returns

The LinphoneRecorderParams object.

LinphoneRecorderState linphone_recorder_get_state

(

const LinphoneRecorder *

recorder

)

Gets the current state of the recorder.

Parameters

recorder

The LinphoneRecorder object.

Returns

the current LinphoneRecorderState.

void* linphone_recorder_get_user_data

(

const LinphoneRecorder *

recorder

)

Retrieves the user data.

Parameters

recorder

The LinphoneRecorder object.

Returns

the user data to retrieve.

LinphoneRecorder* linphone_recorder_new	(	LinphoneCore *	core,
		const LinphoneRecorderParams *	params
	)

Create a new LinphoneRecorder object.

Parameters

core	The LinphoneCore object.
params	The LinphoneRecorderParams object.

Returns

the newly created LinphoneRecorder object.

LinphoneStatus linphone_recorder_open	(	LinphoneRecorder *	recorder,
		const char *	file
	)

Opens a file for recording.

If the file already exists, it will open in append mode, otherwise it is created.

Parameters

recorder	The LinphoneRecorder object.
file	The path to the file to open.

LinphoneRecorderParams* linphone_recorder_params_clone

(

const LinphoneRecorderParams *

params

)

Clone a LinphoneRecorderParams object.

Parameters

params

The LinphoneRecorderParams object.

Returns

the cloned LinphoneRecorderParams object.

const LinphoneAudioDevice* linphone_recorder_params_get_audio_device

(

const LinphoneRecorderParams *

params

)

Retrieve the LinphoneAudioDevice object.

Parameters

params

The LinphoneRecorderParams object.

Returns

the LinphoneAudioDevice object.

LinphoneMediaFileFormat linphone_recorder_params_get_file_format

(

const LinphoneRecorderParams *

params

)

Retrieves the LinphoneMediaFileFormat.

Parameters

params

The LinphoneRecorderParams object.

Returns

the LinphoneMediaFileFormat.

const char* linphone_recorder_params_get_video_codec

(

const LinphoneRecorderParams *

params

)

Retrieves the video codec.

Parameters

params

The LinphoneRecorderParams object.

Returns

the video codec.

const char* linphone_recorder_params_get_webcam_name

(

const LinphoneRecorderParams *

params

)

Retrieves the webcam name.

Parameters

params

The LinphoneRecorderParams object.

Returns

the webcam name.

void* linphone_recorder_params_get_window_id

(

const LinphoneRecorderParams *

params

)

Retrieves the window id used to display the camera preview.

Parameters

params

The LinphoneRecorderParams object.

Returns

the window id.

LinphoneRecorderParams* linphone_recorder_params_new

(

void

)

Create a new LinphoneRecorderParams object.

Returns

the newly created LinphoneRecorderParams object.

LinphoneRecorderParams* linphone_recorder_params_ref

(

LinphoneRecorderParams *

params

)

Take a reference on a LinphoneRecorderParams object.

Parameters

params

The LinphoneRecorderParams object.

Returns

the same LinphoneRecorderParams object.

void linphone_recorder_params_set_audio_device	(	LinphoneRecorderParams *	params,
		const LinphoneAudioDevice *	device
	)

Set the LinphoneAudioDevice object.

Parameters

params	The LinphoneRecorderParams object.
device	The LinphoneAudioDevice object to set.

void linphone_recorder_params_set_file_format	(	LinphoneRecorderParams *	params,
		LinphoneMediaFileFormat	format
	)

Set the LinphoneMediaFileFormat.

See also

linphone_core_get_supported_file_formats_list() for information about supported file formats.

Parameters

params	The LinphoneRecorderParams object.
format	The LinphoneMediaFileFormat to set.

void linphone_recorder_params_set_video_codec	(	LinphoneRecorderParams *	params,
		const char *	video_codec
	)

Set the video codec.

Parameters

params	The LinphoneRecorderParams object.
video_codec	The video codec to set.

void linphone_recorder_params_set_webcam_name	(	LinphoneRecorderParams *	params,
		const char *	webcam_name
	)

Set the webcam name.

Parameters

params	The LinphoneRecorderParams object.
webcam_name	The webcam name to set.

void linphone_recorder_params_set_window_id	(	LinphoneRecorderParams *	params,
		void *	window_id
	)

Sets the window id to use to display the camera preview.

See also

linphone_core_set_native_window_id() for a general discussion about window ID types.

Parameters

params	The LinphoneRecorderParams object.
window_id	The window id to set.

void linphone_recorder_params_unref

(

LinphoneRecorderParams *

params

)

Release a LinphoneRecorderParams object.

Parameters

params

The LinphoneRecorderParams object.

LinphoneStatus linphone_recorder_pause

(

LinphoneRecorder *

recorder

)

Pauses the recording.

Parameters

recorder

The LinphoneRecorder object.

LinphoneRecorder* linphone_recorder_ref

(

LinphoneRecorder *

recorder

)

Take a reference on a LinphoneRecorder object.

Parameters

recorder

The LinphoneRecorder object.

Returns

the same LinphoneRecorder object.

void linphone_recorder_set_params	(	LinphoneRecorder *	recorder,
		LinphoneRecorderParams *	params
	)

Sets the LinphoneRecorderParams object.

Parameters

recorder	The LinphoneRecorder object.
params	The LinphoneRecorderParams object to set.

void linphone_recorder_set_user_data	(	LinphoneRecorder *	recorder,
		void *	user_data
	)

Sets the user data.

Parameters

recorder	The LinphoneRecorder object.
user_data	The user data to set.

LinphoneStatus linphone_recorder_start

(

LinphoneRecorder *

recorder

)

Starts the recording into the opened file.

Parameters

recorder

The LinphoneRecorder object.

void linphone_recorder_unref

(

LinphoneRecorder *

recorder

)

Release a LinphoneRecorder object.

Parameters

recorder

The LinphoneRecorder object.