A B C D F G H I K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- activeAt() - Method in class io.openvidu.java.client.Connection
-
Timestamp when this Connection was taken by a user (passing from status "pending" to "active"), in UTC milliseconds (ms since Jan 1, 1970, 00:00:00 UTC)
- adaptativeBitrate - Static variable in class io.openvidu.java.client.ConnectionProperties.DefaultValues
- adaptativeBitrate() - Method in class io.openvidu.java.client.Connection
-
Whether the Connection uses adaptative bitrate (and therefore adaptative quality) or not.
- adaptativeBitrate() - Method in class io.openvidu.java.client.ConnectionProperties
-
Whether this Connection uses adaptative bitrate (and therefore adaptative quality) or not.
- adaptativeBitrate(boolean) - Method in class io.openvidu.java.client.ConnectionProperties.Builder
-
Call this method to set whether to use adaptative bitrate (and therefore adaptative quality) or not.
- addCustomIceServer(IceServerProperties) - Method in class io.openvidu.java.client.ConnectionProperties.Builder
-
On certain type of networks, clients using default OpenVidu STUN/TURN server can not be reached it because firewall rules and network topologies at the client side.
- allowedFilters(String[]) - Method in class io.openvidu.java.client.KurentoOptions.Builder
-
Set value for
KurentoOptions.getAllowedFilters()
- allowTranscoding - Static variable in class io.openvidu.java.client.SessionProperties.DefaultValues
- allowTranscoding(Boolean) - Method in class io.openvidu.java.client.SessionProperties.Builder
-
Call this method to define if you want to allow transcoding in the media server or not when
SessionProperties.Builder.forcedVideoCodec(VideoCodec)
is not compatible with the browser/client.
If defined here, this parameter has prevalence over OPENVIDU_STREAMS_ALLOW_TRANSCODING. - ALWAYS - io.openvidu.java.client.RecordingMode
-
The session is recorded automatically as soon as the first client publishes a stream to the session.
B
- BEST_FIT - io.openvidu.java.client.RecordingLayout
-
All the videos are evenly distributed, taking up as much space as possible
- build() - Method in class io.openvidu.java.client.ConnectionProperties.Builder
-
Builder for
ConnectionProperties
. - build() - Method in class io.openvidu.java.client.IceServerProperties.Builder
-
Builder for
RecordingProperties
- build() - Method in class io.openvidu.java.client.KurentoOptions.Builder
-
Builder for
KurentoOptions
- 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
-
Deprecated.Builder for
TokenOptions
. - Builder() - Constructor for class io.openvidu.java.client.ConnectionProperties.Builder
- Builder() - Constructor for class io.openvidu.java.client.IceServerProperties.Builder
- Builder() - Constructor for class io.openvidu.java.client.KurentoOptions.Builder
- 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
-
Deprecated.
- Builder(RecordingProperties) - Constructor for class io.openvidu.java.client.RecordingProperties.Builder
C
- clone() - Method in class io.openvidu.java.client.IceServerProperties.Builder
- close() - Method in class io.openvidu.java.client.Session
-
Gracefully closes the Session: unpublishes all streams and evicts every participant.
- COMPOSED - io.openvidu.java.client.Recording.OutputMode
-
Record all streams in a grid layout in a single archive
- COMPOSED_QUICK_START - io.openvidu.java.client.Recording.OutputMode
-
Works the same way as COMPOSED mode, but the necessary recorder service module will start some time in advance and won't be terminated once a specific session recording has ended.
- Connection - Class in io.openvidu.java.client
- ConnectionProperties - Class in io.openvidu.java.client
- ConnectionProperties.Builder - Class in io.openvidu.java.client
-
Builder for
ConnectionProperties
- ConnectionProperties.DefaultValues - Class in io.openvidu.java.client
- ConnectionType - Enum in io.openvidu.java.client
- createConnection() - Method in class io.openvidu.java.client.Session
-
Same as
Session.createConnection(ConnectionProperties)
but with default ConnectionProperties values. - createConnection(ConnectionProperties) - Method in class io.openvidu.java.client.Session
-
Creates a new Connection object associated to Session object and configured with
connectionProperties
. - createdAt() - Method in class io.openvidu.java.client.Connection
-
Timestamp when this Connection was created, in UTC milliseconds (ms since Jan 1, 1970, 00:00:00 UTC)
- createdAt() - Method in class io.openvidu.java.client.Publisher
-
Timestamp when this Publisher started publishing, in UTC milliseconds (ms since Jan 1, 1970, 00:00:00 UTC)
- createdAt() - Method in class io.openvidu.java.client.Session
-
Timestamp when this session was created, in UTC milliseconds (ms since Jan 1, 1970, 00:00:00 UTC).
- 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
- credential(String) - Method in class io.openvidu.java.client.IceServerProperties.Builder
-
Set a credential for the ICE Server you want to use.
- CUSTOM - io.openvidu.java.client.RecordingLayout
-
Use your own custom recording layout.
- customIceServers - Static variable in class io.openvidu.java.client.ConnectionProperties.DefaultValues
- customLayout - Static variable in class io.openvidu.java.client.RecordingProperties.DefaultValues
- customLayout() - Method in class io.openvidu.java.client.RecordingProperties
-
If
RecordingProperties.recordingLayout()
is set toRecordingLayout.CUSTOM
, this property defines the relative path to the specific custom layout you want to use.
See Custom recording layouts to learn more - customLayout(String) - Method in class io.openvidu.java.client.RecordingProperties.Builder
-
If setting
RecordingProperties.Builder.recordingLayout(RecordingLayout)
toRecordingLayout.CUSTOM
you can call this method to set the relative path to the specific custom layout you want to use.
See Custom recording layouts to learn more - customSessionId - Static variable in class io.openvidu.java.client.SessionProperties.DefaultValues
- customSessionId() - Method in class io.openvidu.java.client.SessionProperties
-
Fixes the value of the sessionId property of the Session.
- 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.
D
- data - Static variable in class io.openvidu.java.client.ConnectionProperties.DefaultValues
- data(String) - Method in class io.openvidu.java.client.ConnectionProperties.Builder
-
Call this method to set the secure (server-side) data associated to this Connection.
- data(String) - Method in class io.openvidu.java.client.TokenOptions.Builder
-
Deprecated.Call this method to set the secure (server-side) data associated to this token.
- defaultRecordingProperties - Static variable in class io.openvidu.java.client.SessionProperties.DefaultValues
- defaultRecordingProperties() - Method in class io.openvidu.java.client.SessionProperties
-
Defines the default recording properties of this session.
- defaultRecordingProperties(RecordingProperties) - Method in class io.openvidu.java.client.SessionProperties.Builder
-
Call this method to set the default recording properties of this session.
- DefaultValues() - Constructor for class io.openvidu.java.client.ConnectionProperties.DefaultValues
- DefaultValues() - Constructor for class io.openvidu.java.client.RecordingProperties.DefaultValues
- DefaultValues() - Constructor for class io.openvidu.java.client.SessionProperties.DefaultValues
- deleteRecording(String) - Method in class io.openvidu.java.client.OpenVidu
-
Deletes a recording.
F
- failed - io.openvidu.java.client.Recording.Status
-
The recording has failed.
- fetch() - Method in class io.openvidu.java.client.OpenVidu
-
Updates every property of every active Session with the current status they have in OpenVidu Server.
- fetch() - Method in class io.openvidu.java.client.Session
-
Updates every property of the Session with the current status it has in OpenVidu Server.
- forceDisconnect(Connection) - Method in class io.openvidu.java.client.Session
-
Removes the Connection from the Session.
- forceDisconnect(String) - Method in class io.openvidu.java.client.Session
-
Same as
forceDisconnect(ConnectionProperties)
but providing theconnectionId
instead of the Connection object. - forcedVideoCodec - Static variable in class io.openvidu.java.client.SessionProperties.DefaultValues
- forcedVideoCodec() - Method in class io.openvidu.java.client.SessionProperties
-
Defines which video codec is being forced to be used in the browser/client.
- forcedVideoCodec(VideoCodec) - Method in class io.openvidu.java.client.SessionProperties.Builder
-
Define which video codec will be forcibly used for this session.
- forcedVideoCodecResolved - Static variable in class io.openvidu.java.client.SessionProperties.DefaultValues
- forcedVideoCodecResolved(VideoCodec) - Method in class io.openvidu.java.client.SessionProperties.Builder
-
Actual video codec that will be forcibly used for this session.
- forceUnpublish(Publisher) - Method in class io.openvidu.java.client.Session
-
Forces some Connection to unpublish a Stream.
- forceUnpublish(String) - Method in class io.openvidu.java.client.Session
-
Same as
forceUnpublish(Publisher)
but providing thestreamId
instead of the Publisher object. - frameRate - Static variable in class io.openvidu.java.client.RecordingProperties.DefaultValues
- frameRate() - Method in class io.openvidu.java.client.RecordingProperties
-
Defines the frame rate of the recorded video.
Will only have effect forRecording.OutputMode.COMPOSED
orRecording.OutputMode.COMPOSED_QUICK_START
recordings withRecordingProperties.hasVideo()
to true. - frameRate(int) - Method in class io.openvidu.java.client.RecordingProperties.Builder
-
Call this method to specify the recording frame rate.
- fromJson(Map<String, ?>) - Static method in class io.openvidu.java.client.ConnectionProperties
-
Obtain a
ConnectionProperties.Builder
directly from a JSON object in the form of a Map - fromJson(Map<String, ?>) - Static method in class io.openvidu.java.client.SessionProperties
-
Obtain a
SessionProperties.Builder
directly from a JSON object in the form of a Map
G
- generateToken() - Method in class io.openvidu.java.client.Session
-
Deprecated.Use
Session.createConnection()
instead to get aConnection
object. - generateToken(TokenOptions) - Method in class io.openvidu.java.client.Session
-
Deprecated.Use
Session.createConnection(ConnectionProperties)
instead to get aConnection
object. - getActiveConnections() - Method in class io.openvidu.java.client.Session
-
Returns the list of active Connections of the Session.
- getActiveSession(String) - Method in class io.openvidu.java.client.OpenVidu
-
Returns an active session.
- getActiveSessions() - Method in class io.openvidu.java.client.OpenVidu
-
Returns the list of active sessions.
- getAllowedFilters() - Method in class io.openvidu.java.client.KurentoOptions
-
Defines the names of the filters the Connection will be able to apply to its published streams.
- getClientData() - Method in class io.openvidu.java.client.Connection
-
Returns the data associated to the connection on the client-side.
- getConnection(String) - Method in class io.openvidu.java.client.Session
-
Returns a Connection of the Session.
- getConnectionId() - Method in class io.openvidu.java.client.Connection
-
Returns the identifier of the Connection.
- getConnections() - Method in class io.openvidu.java.client.Session
-
Returns all the Connections of the Session.
- getCreatedAt() - Method in class io.openvidu.java.client.Recording
-
Time when the recording started in UTC milliseconds
- getCredential() - Method in class io.openvidu.java.client.IceServerProperties
-
Returns the credential to be used for TURN connections at the defined
IceServerProperties.getUrl()
andIceServerProperties.getUsername()
for thisIceServerProperties
object. - getCustomIceServers() - Method in class io.openvidu.java.client.Connection
-
Returns a list of custom ICE Servers configured for this connection.
- getCustomIceServers() - Method in class io.openvidu.java.client.ConnectionProperties
-
Returns a list of custom ICE Servers configured for this connection.
- getCustomLayout() - Method in class io.openvidu.java.client.Recording
-
The custom layout used in this recording.
- getData() - Method in class io.openvidu.java.client.ConnectionProperties
-
Returns the secure (server-side) metadata assigned to this Connection.
- getData() - Method in class io.openvidu.java.client.TokenOptions
-
Deprecated.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)
- getFrameRate() - Method in class io.openvidu.java.client.Publisher
-
See properties of Stream object in OpenVidu Browser library to find out more
- getFrameRate() - Method in class io.openvidu.java.client.Recording
-
Frame rate of the video file.
- getId() - Method in class io.openvidu.java.client.Recording
-
Recording unique identifier
- getIp() - Method in class io.openvidu.java.client.Connection
-
Returns the IP of the connection, as seen by OpenVidu Server
- getKurentoOptions() - Method in class io.openvidu.java.client.ConnectionProperties
-
Returns the KurentoOptions assigned to this Connection.
- getKurentoOptions() - Method in class io.openvidu.java.client.TokenOptions
-
Deprecated.Returns the Kurento options assigned to this token
- getLocation() - Method in class io.openvidu.java.client.Connection
-
PRO Returns the geo location of the connection, with the following format:
"CITY, COUNTRY"
("unknown"
if it wasn't possible to locate it) - getName() - Method in class io.openvidu.java.client.Recording
-
Name of the recording.
- getNetworkCache() - Method in class io.openvidu.java.client.Connection
-
Returns the size of the buffer of the endpoint receiving the IP camera's stream, in milliseconds.
- getNetworkCache() - Method in class io.openvidu.java.client.ConnectionProperties
-
Size of the buffer of the endpoint receiving the IP camera's stream, in milliseconds.
- getOutputMode() - Method in class io.openvidu.java.client.Recording
-
Mode of recording: COMPOSED for a single archive in a grid layout or INDIVIDUAL for one archive for each stream
- getPlatform() - Method in class io.openvidu.java.client.Connection
-
Returns a complete description of the platform used by the participant to connect to the session
- getProperties() - Method in class io.openvidu.java.client.Session
-
Returns the properties defining the session.
- getPublishers() - Method in class io.openvidu.java.client.Connection
-
Returns the list of Publisher objects this particular Connection is publishing to the Session (each Publisher object has one Stream, uniquely identified by its
streamId
). - 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.
- getResolution() - Method in class io.openvidu.java.client.Recording
-
Resolution of the video file.
- getRole() - Method in class io.openvidu.java.client.Connection
-
Returns the role of the Connection.
- getRole() - Method in class io.openvidu.java.client.ConnectionProperties
-
Returns the role assigned to this Connection.
- getRole() - Method in class io.openvidu.java.client.TokenOptions
-
Deprecated.Returns the role assigned to this token.
- getRtspUri() - Method in class io.openvidu.java.client.Connection
-
Returns the RTSP URI of the Connection.
- getRtspUri() - Method in class io.openvidu.java.client.ConnectionProperties
-
Returns the RTSP URI of this Connection.
- getServerData() - Method in class io.openvidu.java.client.Connection
-
Returns the data associated to the Connection on the server-side.
- 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 class io.openvidu.java.client.Connection
-
Returns the status of the Connection.
- getStatus() - Method in exception io.openvidu.java.client.OpenViduHttpException
- getStatus() - Method in class io.openvidu.java.client.Recording
-
Status of the recording
- getStreamId() - Method in class io.openvidu.java.client.Publisher
-
Returns the unique identifier of the Stream associated to this Publisher.
- getSubscribers() - Method in class io.openvidu.java.client.Connection
-
Returns the list of streams (their
streamId
properties) this particular Connection is subscribed to. - getToken() - Method in class io.openvidu.java.client.Connection
-
Returns the token string associated to the Connection.
- getType() - Method in class io.openvidu.java.client.Connection
-
Returns the type of Connection.
- getType() - Method in class io.openvidu.java.client.ConnectionProperties
-
Returns the type of Connection.
- getTypeOfVideo() - Method in class io.openvidu.java.client.Publisher
-
See properties of Stream object in OpenVidu Browser library to find out more
- getUrl() - Method in class io.openvidu.java.client.IceServerProperties
-
Returns the defined ICE Server url for this
IceServerProperties
object. - getUrl() - Method in class io.openvidu.java.client.Recording
-
URL of the recording.
- getUsername() - Method in class io.openvidu.java.client.IceServerProperties
-
Returns the Username to be used for TURN connections at the defined
IceServerProperties.getUrl()
andIceServerProperties.getCredential()
for thisIceServerProperties
object. - getVideoDimensions() - Method in class io.openvidu.java.client.Publisher
-
See properties of Stream object in OpenVidu Browser library to find out more
- getVideoMaxRecvBandwidth() - Method in class io.openvidu.java.client.KurentoOptions
-
Defines the maximum number of Kbps that the Connection will be able to receive from Kurento Media Server per media stream.
- getVideoMaxSendBandwidth() - Method in class io.openvidu.java.client.KurentoOptions
-
Defines the maximum number of Kbps that the Connection will be able to send to Kurento Media Server per media stream.
- getVideoMinRecvBandwidth() - Method in class io.openvidu.java.client.KurentoOptions
-
Defines the minimum number of Kbps that the Connection will try to receive from Kurento Media Server per media stream.
- getVideoMinSendBandwidth() - Method in class io.openvidu.java.client.KurentoOptions
-
Defines the minimum number of Kbps that the Connection will try to send to Kurento Media Server per media stream.
H
- H264 - io.openvidu.java.client.VideoCodec
- hasAudio - Static variable in class io.openvidu.java.client.RecordingProperties.DefaultValues
- hasAudio() - Method in class io.openvidu.java.client.Publisher
-
See properties of Stream object in OpenVidu Browser library to find out more
- hasAudio() - Method in class io.openvidu.java.client.Recording
-
true
if the recording has an audio track,false
otherwise (currently fixed to true) - hasAudio() - Method in class io.openvidu.java.client.RecordingProperties
-
Defines whether to record audio or not.
- hasAudio(boolean) - Method in class io.openvidu.java.client.RecordingProperties.Builder
-
Call this method to specify whether to record audio or not.
- hasVideo - Static variable in class io.openvidu.java.client.RecordingProperties.DefaultValues
- hasVideo() - Method in class io.openvidu.java.client.Publisher
-
See properties of Stream object in OpenVidu Browser library to find out more
- hasVideo() - Method in class io.openvidu.java.client.Recording
-
true
if the recording has a video track,false
otherwise (currently fixed to true) - hasVideo() - Method in class io.openvidu.java.client.RecordingProperties
-
Defines whether to record video or not.
- hasVideo(boolean) - Method in class io.openvidu.java.client.RecordingProperties.Builder
-
Call this method to specify whether to record video or not.
- HORIZONTAL_PRESENTATION - io.openvidu.java.client.RecordingLayout
-
(not available yet)
I
- IceServerProperties - Class in io.openvidu.java.client
- IceServerProperties.Builder - Class in io.openvidu.java.client
-
Builder for
IceServerProperties
- ignoreEmptyUrl(boolean) - Method in class io.openvidu.java.client.IceServerProperties.Builder
- ignoreFailedStreams - Static variable in class io.openvidu.java.client.RecordingProperties.DefaultValues
- ignoreFailedStreams() - Method in class io.openvidu.java.client.Recording
-
Whether failed streams were ignored when the recording process started or not.
- ignoreFailedStreams() - Method in class io.openvidu.java.client.RecordingProperties
-
Defines whether to ignore failed streams or not when starting the recording.
- ignoreFailedStreams(boolean) - Method in class io.openvidu.java.client.RecordingProperties.Builder
-
Call this method to specify whether to ignore failed streams or not when starting the recording.
- INDIVIDUAL - io.openvidu.java.client.Recording.OutputMode
-
Record each stream individually
- io.openvidu.java.client - package io.openvidu.java.client
- IPCAM - io.openvidu.java.client.ConnectionType
-
IP camera connection.
- isAudioActive() - Method in class io.openvidu.java.client.Publisher
-
See properties of Stream object in OpenVidu Browser library to find out more
- isBeingBroadcasted() - Method in class io.openvidu.java.client.Session
-
Returns whether the session is being broadcasted or not.
- isBeingRecorded() - Method in class io.openvidu.java.client.Session
-
Returns whether the session is being recorded or not.
- isFilterAllowed(String) - Method in class io.openvidu.java.client.KurentoOptions
-
See if the Connection can apply certain filter.
- isTranscodingAllowed() - Method in class io.openvidu.java.client.SessionProperties
-
Defines if transcoding is allowed or not when
SessionProperties.forcedVideoCodec
is not a compatible codec with the browser/client. - isVideoActive() - Method in class io.openvidu.java.client.Publisher
-
See properties of Stream object in OpenVidu Browser library to find out more
K
- kurentoOptions - Static variable in class io.openvidu.java.client.ConnectionProperties.DefaultValues
- kurentoOptions(KurentoOptions) - Method in class io.openvidu.java.client.ConnectionProperties.Builder
-
Call this method to set a
KurentoOptions
object for this Connection. - kurentoOptions(KurentoOptions) - Method in class io.openvidu.java.client.TokenOptions.Builder
-
Deprecated.Call this method to set a
KurentoOptions
object for this token. - KurentoOptions - Class in io.openvidu.java.client
- KurentoOptions(Integer, Integer, Integer, Integer, String[]) - Constructor for class io.openvidu.java.client.KurentoOptions
- KurentoOptions.Builder - Class in io.openvidu.java.client
-
Builder for
KurentoOptions
L
- listRecordings() - Method in class io.openvidu.java.client.OpenVidu
-
Lists all existing recordings
M
- MANUAL - io.openvidu.java.client.RecordingMode
-
The session is not recorded automatically.
- MEDIA_SERVER_PREFERRED - io.openvidu.java.client.VideoCodec
- mediaMode - Static variable in class io.openvidu.java.client.SessionProperties.DefaultValues
- 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 Node (
MediaMode.ROUTED
) or attempting direct p2p connections (MediaMode.RELAYED
, not available yet) - 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 Node (
MediaMode.ROUTED
) or attempting direct p2p connections (MediaMode.RELAYED
, not available yet)
Default value isMediaMode.ROUTED
- MediaMode - Enum in io.openvidu.java.client
- mediaNode - Static variable in class io.openvidu.java.client.SessionProperties.DefaultValues
- mediaNode() - Method in class io.openvidu.java.client.RecordingProperties
-
PRO The Media Node where to host the recording.
- mediaNode() - Method in class io.openvidu.java.client.SessionProperties
-
PRO The Media Node where to host the session.
- mediaNode(String) - Method in class io.openvidu.java.client.RecordingProperties.Builder
-
PRO Call this method to force the recording to be hosted in the Media Node with identifier
mediaNodeId
. - mediaNode(String) - Method in class io.openvidu.java.client.SessionProperties.Builder
-
PRO Call this method to force the session to be hosted in the Media Node with identifier
mediaNodeId
- MODERATOR - io.openvidu.java.client.OpenViduRole
-
SUBSCRIBER + PUBLISHER permissions + can force the unpublishing or disconnection over a third-party Stream or Connection (call
Session.forceUnpublish()
andSession.forceDisconnect()
)
N
- name - Static variable in class io.openvidu.java.client.RecordingProperties.DefaultValues
- name() - Method in class io.openvidu.java.client.RecordingProperties
-
Defines the name you want to give to the video file
- name(String) - Method in class io.openvidu.java.client.RecordingProperties.Builder
-
Call this method to set the name of the video file
- networkCache - Static variable in class io.openvidu.java.client.ConnectionProperties.DefaultValues
- networkCache(int) - Method in class io.openvidu.java.client.ConnectionProperties.Builder
-
Call this method to set the size of the buffer of the endpoint receiving the IP camera's stream, in milliseconds.
- NONE - io.openvidu.java.client.VideoCodec
O
- onlyPlayWithSubscribers - Static variable in class io.openvidu.java.client.ConnectionProperties.DefaultValues
- onlyPlayWithSubscribers() - Method in class io.openvidu.java.client.Connection
-
Whether the IP camera stream of this Connection will only be enabled when some user is subscribed to it, or not.
- onlyPlayWithSubscribers() - Method in class io.openvidu.java.client.ConnectionProperties
-
Whether to enable the IP camera stream only when some user is subscribed to it.
- onlyPlayWithSubscribers(boolean) - Method in class io.openvidu.java.client.ConnectionProperties.Builder
-
Call this method to set whether to enable the IP camera stream only when some user is subscribed to it, or not.
- OpenVidu - Class in io.openvidu.java.client
- OpenVidu(String, String) - Constructor for class io.openvidu.java.client.OpenVidu
- OpenVidu(String, String, HttpClientBuilder) - Constructor for class io.openvidu.java.client.OpenVidu
- OpenVidu(String, HttpClientBuilder) - Constructor for class io.openvidu.java.client.OpenVidu
- OpenViduException - Exception in io.openvidu.java.client
-
Defines a generic OpenVidu exception
- OpenViduHttpException - Exception in io.openvidu.java.client
-
Defines error responses from OpenVidu Server.
- OpenViduJavaClientException - Exception in io.openvidu.java.client
-
Defines unexpected internal errors in OpenVidu Java Client
- OpenViduRole - Enum in io.openvidu.java.client
- outputMode - Static variable in class io.openvidu.java.client.RecordingProperties.DefaultValues
- outputMode() - Method in class io.openvidu.java.client.RecordingProperties
-
Defines the mode of recording:
Recording.OutputMode.COMPOSED
orRecording.OutputMode.COMPOSED_QUICK_START
for a single archive in a grid layout orRecording.OutputMode.INDIVIDUAL
for one archive for each stream.
Default toOutputMode.COMPOSED
- outputMode(Recording.OutputMode) - Method in class io.openvidu.java.client.RecordingProperties.Builder
-
Call this method to set the mode of recording:
Recording.OutputMode.COMPOSED
orRecording.OutputMode.COMPOSED_QUICK_START
for a single archive in a grid layout orRecording.OutputMode.INDIVIDUAL
for one archive for each stream.
P
- PICTURE_IN_PICTURE - io.openvidu.java.client.RecordingLayout
-
(not available yet)
- Publisher - Class in io.openvidu.java.client
- PUBLISHER - io.openvidu.java.client.OpenViduRole
-
SUBSCRIBER permissions + can publish their own Streams (call
Session.publish()
)
R
- ready - io.openvidu.java.client.Recording.Status
-
The recording has finished being processed and is available for download through property
Recording.getUrl()
- record - Static variable in class io.openvidu.java.client.ConnectionProperties.DefaultValues
- record() - Method in class io.openvidu.java.client.Connection
-
Whether the streams published by this Connection will be recorded or not.
- record() - Method in class io.openvidu.java.client.ConnectionProperties
-
PRO Whether the streams published by this Connection will be recorded or not.
- record(boolean) - Method in class io.openvidu.java.client.ConnectionProperties.Builder
-
Call this method to flag the streams published by this Connection to be recorded or not.
- Recording - Class in io.openvidu.java.client
- Recording.OutputMode - Enum in io.openvidu.java.client
- Recording.Status - Enum in io.openvidu.java.client
- recordingLayout - Static variable in class io.openvidu.java.client.RecordingProperties.DefaultValues
- recordingLayout() - Method in class io.openvidu.java.client.RecordingProperties
-
Defines the layout to be used in the recording.
Will only have effect forRecording.OutputMode.COMPOSED
orRecording.OutputMode.COMPOSED_QUICK_START
recordings withRecordingProperties.hasVideo()
to true. - 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 - Enum in io.openvidu.java.client
- recordingMode - Static variable in class io.openvidu.java.client.SessionProperties.DefaultValues
- recordingMode() - Method in class io.openvidu.java.client.SessionProperties
-
Defines whether the Session will be automatically recorded (
RecordingMode.ALWAYS
) or not (RecordingMode.MANUAL
) - 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 isRecordingMode.MANUAL
- RecordingMode - Enum in io.openvidu.java.client
- RecordingProperties - Class in io.openvidu.java.client
- RecordingProperties.Builder - Class in io.openvidu.java.client
-
Builder for
RecordingProperties
- RecordingProperties.DefaultValues - Class in io.openvidu.java.client
- RELAYED - io.openvidu.java.client.MediaMode
-
(not available yet) The session will attempt to transmit streams directly between clients
- resolution - Static variable in class io.openvidu.java.client.RecordingProperties.DefaultValues
- resolution() - Method in class io.openvidu.java.client.RecordingProperties
-
Defines the resolution of the recorded video.
Will only have effect forRecording.OutputMode.COMPOSED
orRecording.OutputMode.COMPOSED_QUICK_START
recordings withRecordingProperties.hasVideo()
to true. - resolution(String) - Method in class io.openvidu.java.client.RecordingProperties.Builder
-
Call this method to specify the recording resolution.
- role - Static variable in class io.openvidu.java.client.ConnectionProperties.DefaultValues
- role(OpenViduRole) - Method in class io.openvidu.java.client.ConnectionProperties.Builder
-
Call this method to set the role assigned to this Connection.
- role(OpenViduRole) - Method in class io.openvidu.java.client.TokenOptions.Builder
-
Deprecated.Call this method to set the role assigned to this token.
- ROUTED - io.openvidu.java.client.MediaMode
-
The session will transmit streams using OpenVidu Media Node
- rtspUri - Static variable in class io.openvidu.java.client.ConnectionProperties.DefaultValues
- rtspUri(String) - Method in class io.openvidu.java.client.ConnectionProperties.Builder
-
Call this method to set the RTSP URI of an IP camera.
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
- SessionProperties.DefaultValues - Class in io.openvidu.java.client
- shmSize - Static variable in class io.openvidu.java.client.RecordingProperties.DefaultValues
- shmSize() - Method in class io.openvidu.java.client.RecordingProperties
-
The amount of shared memory reserved for the recording process in bytes.
- shmSize(long) - Method in class io.openvidu.java.client.RecordingProperties.Builder
-
Call this method to specify the amount of shared memory reserved for the recording process in bytes.
- startBroadcast(String, String) - Method in class io.openvidu.java.client.OpenVidu
-
Starts the broadcast of a
Session
- startBroadcast(String, String, RecordingProperties) - Method in class io.openvidu.java.client.OpenVidu
-
Starts the broadcast of a
Session
- started - io.openvidu.java.client.Recording.Status
-
The recording has started and is going on
- starting - io.openvidu.java.client.Recording.Status
-
The recording is starting (cannot be stopped).
- startRecording(String) - Method in class io.openvidu.java.client.OpenVidu
-
Starts the recording of a
Session
- 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
- staticAuthSecret(String) - Method in class io.openvidu.java.client.IceServerProperties.Builder
-
Secret for TURN authentication based on: https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00 https://www.ietf.org/proceedings/87/slides/slides-87-behave-10.pdf This will generate credentials valid for 24 hours which is the recommended value.
- stopBroadcast(String) - Method in class io.openvidu.java.client.OpenVidu
-
Stops the broadcast of a
Session
- stopped - io.openvidu.java.client.Recording.Status
-
The recording has stopped and is being processed.
- stopRecording(String) - Method in class io.openvidu.java.client.OpenVidu
-
Stops the recording of a
Session
- SUBSCRIBER - io.openvidu.java.client.OpenViduRole
-
Can subscribe to published Streams of other users
T
- toJson() - Method in class io.openvidu.java.client.KurentoOptions
- toJson() - Method in class io.openvidu.java.client.SessionProperties
- toJson(String) - Method in class io.openvidu.java.client.ConnectionProperties
- TokenOptions - Class in io.openvidu.java.client
-
Deprecated.Use
ConnectionProperties
instead - TokenOptions.Builder - Class in io.openvidu.java.client
-
Deprecated.Use
ConnectionProperties.Builder
instead - type - Static variable in class io.openvidu.java.client.ConnectionProperties.DefaultValues
- type(ConnectionType) - Method in class io.openvidu.java.client.ConnectionProperties.Builder
-
Call this method to set the type of Connection.
U
- updateConnection(String, ConnectionProperties) - Method in class io.openvidu.java.client.Session
-
PRO Updates the properties of a Connection with a
ConnectionProperties
object. - url(String) - Method in class io.openvidu.java.client.IceServerProperties.Builder
-
Set the url for the ICE Server you want to use.
- username(String) - Method in class io.openvidu.java.client.IceServerProperties.Builder
-
Set a username for the ICE Server you want to use.
V
- valueOf(String) - Static method in enum io.openvidu.java.client.ConnectionType
-
Returns the enum constant of this type with the specified name.
- 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.OutputMode
-
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.
- valueOf(String) - Static method in enum io.openvidu.java.client.VideoCodec
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.openvidu.java.client.ConnectionType
-
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.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.OutputMode
-
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.
- values() - Static method in enum io.openvidu.java.client.VideoCodec
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VERTICAL_PRESENTATION - io.openvidu.java.client.RecordingLayout
-
(not available yet)
- VideoCodec - Enum in io.openvidu.java.client
- videoMaxRecvBandwidth(int) - Method in class io.openvidu.java.client.KurentoOptions.Builder
-
Set value for
KurentoOptions.getVideoMaxRecvBandwidth()
- videoMaxSendBandwidth(int) - Method in class io.openvidu.java.client.KurentoOptions.Builder
-
Set value for
KurentoOptions.getVideoMaxSendBandwidth()
- videoMinRecvBandwidth(int) - Method in class io.openvidu.java.client.KurentoOptions.Builder
-
Set value for
KurentoOptions.getVideoMinRecvBandwidth()
- videoMinSendBandwidth(int) - Method in class io.openvidu.java.client.KurentoOptions.Builder
-
Set value for
KurentoOptions.getVideoMinSendBandwidth()
- VP8 - io.openvidu.java.client.VideoCodec
- VP9 - io.openvidu.java.client.VideoCodec
W
- WEBRTC - io.openvidu.java.client.ConnectionType
-
WebRTC connection.
All Classes All Packages