Package io.openvidu.java.client
Class Recording
- java.lang.Object
-
- io.openvidu.java.client.Recording
-
public class Recording extends Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Recording.OutputMode
SeegetOutputMode()
static class
Recording.Status
SeegetStatus()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description long
getCreatedAt()
Time when the recording started in UTC millisecondsString
getCustomLayout()
The custom layout used in this recording.double
getDuration()
Duration of the recording in seconds (0 until the recording is stopped)Integer
getFrameRate()
Frame rate of the video file.String
getId()
Recording unique identifierString
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 streamRecordingLayout
getRecordingLayout()
The layout used in this recording.String
getResolution()
Resolution of the video file.String
getSessionId()
Session associated to the recordinglong
getSize()
Size of the recording in bytes (0 until the recording is stopped)Recording.Status
getStatus()
Status of the recordingString
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)boolean
ignoreFailedStreams()
Whether failed streams were ignored when the recording process started or not.
-
-
-
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
-
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)
-
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 applicable ifRecording.OutputMode
isRecording.OutputMode.COMPOSED
orRecording.OutputMode.COMPOSED_QUICK_START
andhasVideo()
is true
-
getCustomLayout
public String getCustomLayout()
The custom layout used in this recording. Only applicable ifRecording.OutputMode
isRecording.OutputMode.COMPOSED
orRecording.OutputMode.COMPOSED_QUICK_START
,hasVideo()
is true andRecordingProperties.Builder.customLayout(String)
has been called
-
ignoreFailedStreams
public boolean ignoreFailedStreams()
Whether failed streams were ignored when the recording process started or not. Only applicable ifRecording.OutputMode
isRecording.OutputMode.INDIVIDUAL
-
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 isnull
until recording reaches "ready" or "failed" status. If OpenVidu configuration propertyOPENVIDU_RECORDING_PUBLIC_ACCESS
is false, this path will be secured with OpenVidu credentials
-
getResolution
public String getResolution()
Resolution of the video file. Only applicable ifRecording.OutputMode
isRecording.OutputMode.COMPOSED
orRecording.OutputMode.COMPOSED_QUICK_START
andhasVideo()
is true
-
getFrameRate
public Integer getFrameRate()
Frame rate of the video file. Only applicable ifRecording.OutputMode
isRecording.OutputMode.COMPOSED
orRecording.OutputMode.COMPOSED_QUICK_START
andhasVideo()
is true
-
-