Index (OpenVidu Java Client 2.0.0 API)

B C D G H I L M N O R S T V

B

build() - Method in class io.openvidu.java.client.RecordingProperties.Builder: Builder for RecordingProperties
build() - Method in class io.openvidu.java.client.SessionProperties.Builder: Returns the SessionProperties object properly configured
build() - Method in class io.openvidu.java.client.TokenOptions.Builder: Builder for TokenOptions
Builder() - Constructor for class io.openvidu.java.client.RecordingProperties.Builder
Builder() - Constructor for class io.openvidu.java.client.SessionProperties.Builder
Builder() - Constructor for class io.openvidu.java.client.TokenOptions.Builder

C

createSession() - Method in class io.openvidu.java.client.OpenVidu: Creates an OpenVidu session with the default settings
createSession(SessionProperties) - Method in class io.openvidu.java.client.OpenVidu: Creates an OpenVidu session
customLayout(String) - Method in class io.openvidu.java.client.RecordingProperties.Builder: If setting RecordingProperties.Builder.recordingLayout(RecordingLayout) to RecordingLayout.CUSTOM you can call this method to set the relative path to the specific custom layout you want to use.
customLayout() - Method in class io.openvidu.java.client.RecordingProperties: If RecordingProperties.recordingLayout() is set to RecordingLayout.CUSTOM, this property defines the relative path to the specific custom layout you want to use.
customSessionId(String) - Method in class io.openvidu.java.client.SessionProperties.Builder: Call this method to fix the sessionId that will be assigned to the session.
customSessionId() - Method in class io.openvidu.java.client.SessionProperties: Fixes the value of the sessionId property of the Session.

D

data(String) - Method in class io.openvidu.java.client.TokenOptions.Builder: Call this method to set the secure (server-side) data associated to this token.
defaultCustomLayout(String) - Method in class io.openvidu.java.client.SessionProperties.Builder: Call this method to set the default value used to initialize property RecordingProperties.customLayout() of every recording of this session.
defaultCustomLayout() - Method in class io.openvidu.java.client.SessionProperties: Defines the default value used to initialize property RecordingProperties.customLayout() of every recording of this session.
defaultRecordingLayout(RecordingLayout) - Method in class io.openvidu.java.client.SessionProperties.Builder: Call this method to set the the default value used to initialize property RecordingProperties.recordingLayout() of every recording of this session.
defaultRecordingLayout() - Method in class io.openvidu.java.client.SessionProperties: Defines the default value used to initialize property RecordingProperties.recordingLayout() of every recording of this session.
deleteRecording(String) - Method in class io.openvidu.java.client.OpenVidu: Deletes a recording.

G

generateToken() - Method in class io.openvidu.java.client.Session: Gets a new token associated to Session object with default values for TokenOptions.
generateToken(TokenOptions) - Method in class io.openvidu.java.client.Session: Gets a new token associated to Session object configured with tokenOptions.
getCreatedAt() - Method in class io.openvidu.java.client.Recording: Time when the recording started in UTC milliseconds
getData() - Method in class io.openvidu.java.client.TokenOptions: Returns the secure (server-side) metadata assigned to this token
getDuration() - Method in class io.openvidu.java.client.Recording: Duration of the recording in seconds (0 until the recording is stopped)
getId() - Method in class io.openvidu.java.client.Recording: Recording unique identifier
getName() - Method in class io.openvidu.java.client.Recording: Name of the recording.
getProperties() - Method in class io.openvidu.java.client.Session: Returns the properties defining the session
getRecording(String) - Method in class io.openvidu.java.client.OpenVidu: Gets an existing recording
getRecordingLayout() - Method in class io.openvidu.java.client.Recording: The layout used in this recording
getRole() - Method in class io.openvidu.java.client.TokenOptions: Returns the role assigned to this token
getSessionId() - Method in class io.openvidu.java.client.Recording: Session associated to the recording
getSessionId() - Method in class io.openvidu.java.client.Session: Gets the unique identifier of the Session
getSize() - Method in class io.openvidu.java.client.Recording: Size of the recording in bytes (0 until the recording is stopped)
getStatus() - Method in exception io.openvidu.java.client.OpenViduHttpException
getStatus() - Method in class io.openvidu.java.client.Recording: Status of the recording
getUrl() - Method in class io.openvidu.java.client.Recording: URL of the recording.

H

hasAudio() - Method in class io.openvidu.java.client.Recording: true if the recording has an audio track, false otherwise (currently fixed to true)
hasVideo() - Method in class io.openvidu.java.client.Recording: true if the recording has a video track, false otherwise (currently fixed to true)

I

io.openvidu.java.client - package io.openvidu.java.client

L

listRecordings() - Method in class io.openvidu.java.client.OpenVidu: Lists all existing recordings

M

MediaMode - Enum in io.openvidu.java.client
mediaMode(MediaMode) - Method in class io.openvidu.java.client.SessionProperties.Builder: Call this method to set how the media streams will be sent and received by your clients: routed through OpenVidu Media Server (MediaMode.ROUTED) or attempting direct p2p connections (MediaMode.RELAYED, not available yet) Default value is MediaMode.ROUTED
mediaMode() - Method in class io.openvidu.java.client.SessionProperties: Defines how the media streams will be sent and received by your clients: routed through OpenVidu Media Server (MediaMode.ROUTED) or attempting direct p2p connections (MediaMode.RELAYED, not available yet)

N

name(String) - Method in class io.openvidu.java.client.RecordingProperties.Builder: Call this method to set the name of the video file.
name() - Method in class io.openvidu.java.client.RecordingProperties: Defines the name you want to give to the video file.

O

OpenVidu - Class in io.openvidu.java.client
OpenVidu(String, String) - Constructor for class io.openvidu.java.client.OpenVidu
OpenViduHttpException - Exception in io.openvidu.java.client: Defines error responses from OpenVidu Server
OpenViduHttpException(int) - Constructor for exception io.openvidu.java.client.OpenViduHttpException
OpenViduJavaClientException - Exception in io.openvidu.java.client: Defines unexpected internal errors in OpenVidu Java Client
OpenViduJavaClientException(String) - Constructor for exception io.openvidu.java.client.OpenViduJavaClientException
OpenViduJavaClientException(String, Throwable) - Constructor for exception io.openvidu.java.client.OpenViduJavaClientException
OpenViduRole - Enum in io.openvidu.java.client

R

Recording - Class in io.openvidu.java.client
Recording(JSONObject) - Constructor for class io.openvidu.java.client.Recording
Recording.Status - Enum in io.openvidu.java.client
RecordingLayout - Enum in io.openvidu.java.client
recordingLayout(RecordingLayout) - Method in class io.openvidu.java.client.RecordingProperties.Builder: Call this method to set the layout to be used in the recording
recordingLayout() - Method in class io.openvidu.java.client.RecordingProperties: Defines the layout to be used in the recording
RecordingMode - Enum in io.openvidu.java.client
recordingMode(RecordingMode) - Method in class io.openvidu.java.client.SessionProperties.Builder: Call this method to set whether the Session will be automatically recorded (RecordingMode.ALWAYS) or not (RecordingMode.MANUAL) Default value is RecordingMode.MANUAL
recordingMode() - Method in class io.openvidu.java.client.SessionProperties: Defines whether the Session will be automatically recorded (RecordingMode.ALWAYS) or not (RecordingMode.MANUAL)
RecordingProperties - Class in io.openvidu.java.client
RecordingProperties.Builder - Class in io.openvidu.java.client
role(OpenViduRole) - Method in class io.openvidu.java.client.TokenOptions.Builder: Call this method to set the role assigned to this token

S

Session - Class in io.openvidu.java.client
SessionProperties - Class in io.openvidu.java.client
SessionProperties.Builder - Class in io.openvidu.java.client: Builder for SessionProperties
startRecording(String, RecordingProperties) - Method in class io.openvidu.java.client.OpenVidu: Starts the recording of a Session
startRecording(String, String) - Method in class io.openvidu.java.client.OpenVidu: Starts the recording of a Session
startRecording(String) - Method in class io.openvidu.java.client.OpenVidu: Starts the recording of a Session
stopRecording(String) - Method in class io.openvidu.java.client.OpenVidu: Stops the recording of a Session

T

TokenOptions - Class in io.openvidu.java.client
TokenOptions.Builder - Class in io.openvidu.java.client: Builder for TokenOptions
toString() - Method in class io.openvidu.java.client.Session

V

valueOf(String) - Static method in enum io.openvidu.java.client.MediaMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.openvidu.java.client.OpenViduRole: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.openvidu.java.client.Recording.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.openvidu.java.client.RecordingLayout: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.openvidu.java.client.RecordingMode: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.openvidu.java.client.MediaMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.openvidu.java.client.OpenViduRole: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.openvidu.java.client.Recording.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.openvidu.java.client.RecordingLayout: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.openvidu.java.client.RecordingMode: Returns an array containing the constants of this enum type, in the order they are declared.

B C D G H I L M N O R S T V