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 classRecording.OutputModeSeegetOutputMode()static classRecording.StatusSeegetStatus()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description longgetCreatedAt()Time when the recording started in UTC millisecondsStringgetCustomLayout()The custom layout used in this recording.doublegetDuration()Duration of the recording in seconds (0 until the recording is stopped)IntegergetFrameRate()Frame rate of the video file.StringgetId()Recording unique identifierStringgetName()Name of the recording.Recording.OutputModegetOutputMode()Mode of recording: COMPOSED for a single archive in a grid layout or INDIVIDUAL for one archive for each streamRecordingLayoutgetRecordingLayout()The layout used in this recording.StringgetResolution()Resolution of the video file.StringgetSessionId()Session associated to the recordinglonggetSize()Size of the recording in bytes (0 until the recording is stopped)Recording.StatusgetStatus()Status of the recordingStringgetUrl()URL of the recording.booleanhasAudio()trueif the recording has an audio track,falseotherwise (currently fixed to true)booleanhasVideo()trueif the recording has a video track,falseotherwise (currently fixed to true)booleanignoreFailedStreams()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()
trueif the recording has an audio track,falseotherwise (currently fixed to true)
-
hasVideo
public boolean hasVideo()
trueif the recording has a video track,falseotherwise (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.OutputModeisRecording.OutputMode.COMPOSEDorRecording.OutputMode.COMPOSED_QUICK_STARTandhasVideo()is true
-
getCustomLayout
public String getCustomLayout()
The custom layout used in this recording. Only applicable ifRecording.OutputModeisRecording.OutputMode.COMPOSEDorRecording.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.OutputModeisRecording.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 isnulluntil recording reaches "ready" or "failed" status. If OpenVidu configuration propertyOPENVIDU_RECORDING_PUBLIC_ACCESSis false, this path will be secured with OpenVidu credentials
-
getResolution
public String getResolution()
Resolution of the video file. Only applicable ifRecording.OutputModeisRecording.OutputMode.COMPOSEDorRecording.OutputMode.COMPOSED_QUICK_STARTandhasVideo()is true
-
getFrameRate
public Integer getFrameRate()
Frame rate of the video file. Only applicable ifRecording.OutputModeisRecording.OutputMode.COMPOSEDorRecording.OutputMode.COMPOSED_QUICK_STARTandhasVideo()is true
-
-