io.openvidu.java.client

Class Recording

java.lang.Object

io.openvidu.java.client.Recording

public class Recording
extends Object

See OpenVidu.startRecording(String)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Recording.OutputMode See getOutputMode()
static class	Recording.Status See getStatus()

Method Summary

Modifier and Type	Method and Description
long	getCreatedAt() Time when the recording started in UTC milliseconds
String	getCustomLayout() The custom layout used in this recording.
double	getDuration() Duration of the recording in seconds (0 until the recording is stopped)
String	getId() Recording unique identifier
String	getName() Name of the recording.
Recording.OutputMode	getOutputMode() Mode of recording: COMPOSED for a single archive in a grid layout or INDIVIDUAL for one archive for each stream
RecordingLayout	getRecordingLayout() The layout used in this recording.
String	getResolution() Resolution of the video file.
String	getSessionId() Session associated to the recording
long	getSize() Size of the recording in bytes (0 until the recording is stopped)
Recording.Status	getStatus() Status of the recording
String	getUrl() URL of the recording.
boolean	hasAudio() true if the recording has an audio track, false otherwise (currently fixed to true)
boolean	hasVideo() true if the recording has a video track, false otherwise (currently fixed to true)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getStatus

public Recording.Status getStatus()

Status of the recording

getId

public String getId()

Recording unique identifier

getName

public String getName()

Name of the recording. The video file will be named after this property. You can access this same value in your clients on recording events (recordingStarted, recordingStopped)

getOutputMode

public Recording.OutputMode getOutputMode()

Mode of recording: COMPOSED for a single archive in a grid layout or INDIVIDUAL for one archive for each stream

getRecordingLayout

public RecordingLayout getRecordingLayout()

The layout used in this recording. Only defined if OutputMode is COMPOSED

getCustomLayout

public String getCustomLayout()

The custom layout used in this recording. Only defined if if OutputMode is COMPOSED and RecordingProperties.Builder.customLayout(String) has been called

getSessionId

public String getSessionId()

Session associated to the recording

getCreatedAt

public long getCreatedAt()

Time when the recording started in UTC milliseconds

getSize

public long getSize()

Size of the recording in bytes (0 until the recording is stopped)

getDuration

public double getDuration()

Duration of the recording in seconds (0 until the recording is stopped)

getUrl

public String getUrl()

URL of the recording. You can access the file from there. It is null until recording reaches "ready" or "failed" status. If OpenVidu Server configuration property openvidu.recording.public-access is false, this path will be secured with OpenVidu credentials

getResolution

public String getResolution()

Resolution of the video file. Only defined if OutputMode of the Recording is set to Recording.OutputMode.COMPOSED

hasAudio

public boolean hasAudio()

true if the recording has an audio track, false otherwise (currently fixed to true)

hasVideo

public boolean hasVideo()

true if the recording has a video track, false otherwise (currently fixed to true)