Package org.linphone.core

Interface Recorder

public interface Recorder

Object used to record the audio or video of a call.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the opened file.
Content	createContent()	Create a content from the recording, for example to send it in a chat message.
float	getCaptureVolume()	Get linear volume when capturing audio.
int	getDuration()	Gets the duration of the recording.
java.lang.String	getFile()	Gets the file used for recording.
long	getNativePointer()	Gets the native pointer used by this class to make native method calls.
RecorderParams	getParams()	Retrieve the RecorderParams object.
RecorderState	getState()	Gets the current state of the recorder.
java.lang.Object	getUserData()	Gets the object stored in this object user's data
int	open(java.lang.String file)	Open a file for recording.
int	pause()	Pause the recording.
void	setParams(RecorderParams params)	Set the RecorderParams object.
void	setUserData(java.lang.Object data)	Sets the object to store in this object user's data
int	start()	Start the recording into the opened file.
java.lang.String	toString()

Method Detail

getCaptureVolume

float getCaptureVolume()

Get linear volume when capturing audio.

Returns:

Linear volume.

getDuration

int getDuration()

Gets the duration of the recording.

Returns:

the duration of the recording, in milliseconds.

getFile

@Nullable
java.lang.String getFile()

Gets the file used for recording.

Returns:

the file used for the recording if any.

getParams

@NonNull
RecorderParams getParams()

Retrieve the RecorderParams object.

Returns:

The RecorderParams object.

setParams

void setParams(@NonNull
               RecorderParams params)

Set the RecorderParams object.

Parameters:

params - The RecorderParams object to set.

getState

RecorderState getState()

Gets the current state of the recorder.

Returns:

the current RecorderState.

close

void close()

Close the opened file.

createContent

@Nullable
Content createContent()

Create a content from the recording, for example to send it in a chat message.

warning: Recorder must be in Closed state!

Returns:

the Content matching the recording, or null.

open

int open(@NonNull
         java.lang.String file)

Open a file for recording.

Parameters:

file - The path to the file to open.

pause

int pause()

Pause the recording.

start

int start()

Start the recording into the opened file.

setUserData

void setUserData(java.lang.Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

java.lang.Object getUserData()

Gets the object stored in this object user's data

Returns:

the object store if any, null otherwise

getNativePointer

long getNativePointer()

Gets the native pointer used by this class to make native method calls.

Returns:

the nativer pointer, as long

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object