A B C D E F G H I J L M N O P R S T U V W Y
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ABGR - Static variable in class com.opentok.android.BaseVideoCapturer
-
Defines the value for the ABGR pixel format used by the
BaseVideoCapturer.CaptureSettings.format
property. - All - com.opentok.android.Session.Builder.IncludeServers
- All - com.opentok.android.Session.Builder.TransportPolicy
- apiKey - Variable in class com.opentok.android.Session
- apiUrl - Variable in class com.opentok.android.Session
- archiveListener - Variable in class com.opentok.android.Session
- ARGB - Static variable in class com.opentok.android.BaseVideoCapturer
-
Defines the value for the ARGB pixel format used by the
BaseVideoCapturer.CaptureSettings.format
property. - attachToSession(Session) - Method in class com.opentok.android.SubscriberKit
- audioBitrate(int) - Method in class com.opentok.android.Publisher.Builder
- audioBitrate(int) - Method in class com.opentok.android.PublisherKit.Builder
-
Sets the desired bitrate for the published audio, in bits per second.
- audioBytesReceived - Variable in class com.opentok.android.SubscriberKit.SubscriberAudioStats
-
The total number of audio bytes received by the subscriber.
- audioBytesSent - Variable in class com.opentok.android.PublisherKit.PublisherAudioStats
-
The total number of audio bytes sent to the subscriber (or to the OpenTok Media Router).
- AudioData - Class in com.opentok.android
-
Defines audio data passed into the PublisherKit.CustomAudioTransformer.transform() method.
- AudioData(long, int, int, int, int) - Constructor for class com.opentok.android.AudioData
- AudioDeviceManager - Class in com.opentok.android
-
Use the AudioDeviceManager to set a custom audio device to be used by the app.
- AudioDeviceManager() - Constructor for class com.opentok.android.AudioDeviceManager
- audioLevelListener - Variable in class com.opentok.android.PublisherKit
- audioLevelListener - Variable in class com.opentok.android.SubscriberKit
- audioPacketsLost - Variable in class com.opentok.android.PublisherKit.PublisherAudioStats
-
The total number of audio packets that did not reach the subscriber (or the OpenTok Media Router).
- audioPacketsLost - Variable in class com.opentok.android.SubscriberKit.SubscriberAudioStats
-
The total number of audio packets lost by the subscriber.
- audioPacketsReceived - Variable in class com.opentok.android.SubscriberKit.SubscriberAudioStats
-
The total number of audio packets lost by the subscriber.
- audioPacketsSent - Variable in class com.opentok.android.PublisherKit.PublisherAudioStats
-
The total number of audio packets sent to the subscriber (or to the OpenTok Media Router).
- AudioSettings(int, int) - Constructor for class com.opentok.android.BaseAudioDevice.AudioSettings
- audioStatsListener - Variable in class com.opentok.android.PublisherKit
- audioStatsListener - Variable in class com.opentok.android.SubscriberKit
- audioTrack(boolean) - Method in class com.opentok.android.Publisher.Builder
- audioTrack(boolean) - Method in class com.opentok.android.PublisherKit.Builder
-
Sets whether to include an audio track in the published stream (
true
, the default) or not (false
). - AudioTransformer(String, PublisherKit.CustomAudioTransformer) - Constructor for class com.opentok.android.PublisherKit.AudioTransformer
-
Creates an instance of a custom audio transformer.
- AudioTransformer(String, String) - Constructor for class com.opentok.android.PublisherKit.AudioTransformer
-
Creates an instance of a Vonage audio transformer.
- AuthorizationFailure - com.opentok.android.OpentokError.ErrorCode
-
An invalid API key or token was provided.
B
- BaseAudioDevice - Class in com.opentok.android
-
Defines an audio device for use in a session.
- BaseAudioDevice() - Constructor for class com.opentok.android.BaseAudioDevice
- BaseAudioDevice.AudioBus - Class in com.opentok.android
-
The audio bus marshals audio data between the network and the audio device.
- BaseAudioDevice.AudioSettings - Class in com.opentok.android
-
Defines the format of the audio when a custom audio driver is used.
- BaseAudioDevice.BluetoothState - Enum in com.opentok.android
-
Defines values for the
BaseAudioDevice.getBluetoothState()
method. - BaseAudioDevice.OutputMode - Enum in com.opentok.android
-
Defines values for the
BaseAudioDevice.setOutputMode(OutputMode mode)
method. - BaseVideoCapturer - Class in com.opentok.android
-
Defines a video capturer to be used by a
PublisherKit
object. - BaseVideoCapturer() - Constructor for class com.opentok.android.BaseVideoCapturer
- BaseVideoCapturer.CaptureSettings - Class in com.opentok.android
-
Defines the capture settings for a video capturer.
- BaseVideoCapturer.CaptureSwitch - Interface in com.opentok.android
-
An interface for defining how the
BaseVideoCapturer.CaptureSwitch.cycleCamera()
method of a Publisher object that implements a custom video capturer. - BaseVideoCapturer.VideoContentHint - Enum in com.opentok.android
-
Defines the content hint settings for a video capturer.
- BaseVideoRenderer - Class in com.opentok.android
-
Defines a video renderer to be used by a PublisherKit object or a SubscriberKit object.
- BaseVideoRenderer() - Constructor for class com.opentok.android.BaseVideoRenderer
- BaseVideoRenderer.Frame - Class in com.opentok.android
-
Defines a frame of a video stream.
- BGRA - Static variable in class com.opentok.android.BaseVideoCapturer
-
Defines the value for the BGRA pixel format used by the
BaseVideoCapturer.CaptureSettings.format
property. - buffer - Variable in class com.opentok.android.BaseVideoRenderer.Frame
- build() - Method in class com.opentok.android.Publisher.Builder
-
Returns a new
Publisher
instance based on thePublisher.Builder
settings. - build() - Method in class com.opentok.android.PublisherKit.Builder
- build() - Method in class com.opentok.android.Session.Builder
-
Returns a new
Session
instance based on theSession.Builder
settings. - build() - Method in class com.opentok.android.Subscriber.Builder
-
Returns a new
Subscriber
instance based on theBuilder
settings. - build() - Method in class com.opentok.android.SubscriberKit.Builder
-
Returns a new
SubscriberKit
instance based on theBuilder
settings. - Builder(Context) - Constructor for class com.opentok.android.Publisher.Builder
-
Instantiates a
Publisher.Builder
object. - Builder(Context) - Constructor for class com.opentok.android.PublisherKit.Builder
-
Instantiates a
PublisherKit.Builder
object. - Builder(Context, Stream) - Constructor for class com.opentok.android.Subscriber.Builder
-
Instantiates a
Subscriber.Builder
object. - Builder(Context, Stream) - Constructor for class com.opentok.android.SubscriberKit.Builder
-
Instantiates a
SubscriberKit.Builder
object. - Builder(Context, String, String) - Constructor for class com.opentok.android.Session.Builder
-
Use this builder to create a Session instance.
C
- CaCertificates - Class in com.opentok.android
- CaCertificates() - Constructor for class com.opentok.android.CaCertificates
- CameraFailed - com.opentok.android.OpentokError.ErrorCode
-
There was an error in acquiring video from the camera.
- cameraFrameRate - Variable in class com.opentok.android.Publisher
- cameraListener - Variable in class com.opentok.android.Publisher
- cameraResolution - Variable in class com.opentok.android.Publisher
- canForceMute - Variable in class com.opentok.android.Session.Capabilities
-
Whether the client can request force mute streams in the session or disable the active mute state in a session (
true
) or not (false
). - canPublish - Variable in class com.opentok.android.Session.Capabilities
-
Whether the client can publish streams to the session (
true
) or not (false
). - canSubscribe - Variable in class com.opentok.android.Session.Capabilities
-
Whether the client can subscribe to streams in the session (
true
) or not (false
). - Capabilities() - Constructor for class com.opentok.android.Session.Capabilities
- captionsListener - Variable in class com.opentok.android.SubscriberKit
- capturer - Variable in class com.opentok.android.PublisherKit
- capturer(BaseVideoCapturer) - Method in class com.opentok.android.Publisher.Builder
-
Sets the video capturer to use for the publisher.
- capturer(BaseVideoCapturer) - Method in class com.opentok.android.PublisherKit.Builder
-
Sets the video capturer to use for the publisher.
- CaptureSettings() - Constructor for class com.opentok.android.BaseVideoCapturer.CaptureSettings
- com.opentok.android - package com.opentok.android
- compareTo(Object) - Method in class com.opentok.android.Stream
- connect(String) - Method in class com.opentok.android.Session
-
Connects to the OpenTok session provided in the Session constructor, using the provided authentication token.
- Connected - com.opentok.android.BaseAudioDevice.BluetoothState
-
A Bluetooth device is connected, and audio is being rendered to it.
- Connection - Class in com.opentok.android
-
Represents a connection between a client and an OpenTok session.
- ConnectionDropped - com.opentok.android.OpentokError.ErrorCode
-
The connection to the OpenTok messaging server was dropped.
- connectionEventsSuppressed(Boolean) - Method in class com.opentok.android.Session.Builder
-
Prevent connection events (such as
Session.ConnectionListener.onConnectionCreated(Session session, Connection connection)
) from being dispatched. - ConnectionFailed - com.opentok.android.OpentokError.ErrorCode
-
The session failed to connect.
- connectionId - Variable in class com.opentok.android.PublisherKit.PublisherAudioStats
-
The connection ID of the client subscribing to the stream.
- connectionId - Variable in class com.opentok.android.PublisherKit.PublisherRtcStats
-
For a relayed session (in which a publisher sends individual media streams to each subscriber), this is the unique ID of the client's connection.
- connectionId - Variable in class com.opentok.android.PublisherKit.PublisherVideoStats
-
The connection ID of the client subscribing to the stream.
- connectionListener - Variable in class com.opentok.android.Session
- ConnectionRefused - com.opentok.android.OpentokError.ErrorCode
-
A socket could not be opened to OpenTok the messaging server.
- ConnectionTimedOut - com.opentok.android.OpentokError.ErrorCode
-
Subscriber timed out while attempting to connect to the stream.
- context - Variable in class com.opentok.android.PublisherKit
- context - Variable in class com.opentok.android.Session
- convertInPlace(ByteBuffer, ByteBuffer, ByteBuffer, int, int) - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Converts video frame without allocating new planes.
- credential - Variable in class com.opentok.android.Session.Builder.IceServer
- Custom - com.opentok.android.Session.Builder.IncludeServers
- cycleCamera() - Method in interface com.opentok.android.BaseVideoCapturer.CaptureSwitch
-
Defines the behavior of the
Publisher.cycleCamera()
method for a Publisher object that uses the custom video capturer. - cycleCamera() - Method in class com.opentok.android.Publisher
-
Cycles between cameras, if there are multiple cameras on the device.
D
- DecryptionInternalError - com.opentok.android.OpentokError.ErrorCode
-
Internal error while decrypting a packet
- destroy() - Method in class com.opentok.android.BaseVideoCapturer
-
Destroys the BaseVideoCapturer object.
- destroy() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Free all resources associated to this frame.
- destroy() - Method in class com.opentok.android.PublisherKit
-
Deprecated.
- destroy() - Method in class com.opentok.android.SubscriberKit
-
Deprecated.
- destroyCapturer() - Method in class com.opentok.android.BaseAudioDevice
-
Stops the audio capturer thread.
- destroyRenderer() - Method in class com.opentok.android.BaseAudioDevice
-
Stops the audio renderer thread.
- detachFromSession(Session) - Method in class com.opentok.android.SubscriberKit
- DETAIL - com.opentok.android.BaseVideoCapturer.VideoContentHint
-
The track should be treated as if video details are extra important.
- disableForceMute() - Method in class com.opentok.android.Session
-
Disables the active mute state of the session.
- disconnect() - Method in class com.opentok.android.Session
-
Disconnects from this session.
- Disconnected - com.opentok.android.BaseAudioDevice.BluetoothState
-
The audio device is not using Bluetooth for rendering.
E
- enableOpusDtx(boolean) - Method in class com.opentok.android.Publisher.Builder
- enableOpusDtx(boolean) - Method in class com.opentok.android.PublisherKit.Builder
- EncryptionInternalError - com.opentok.android.OpentokError.ErrorCode
-
Internal error while encrypting a packet
- EncryptionSecretMismatch - com.opentok.android.OpentokError.ErrorCode
-
Secret mismatch while decrypting a packet
- EncryptionSecretMissing - com.opentok.android.OpentokError.ErrorCode
-
Tried to join an end-to-end encrypted session without an encryption secret
- equals(int, int) - Method in class com.opentok.android.VideoUtils.Size
-
Checks to see if the Size object matches the specified height and width.
- equals(Object) - Method in class com.opentok.android.Connection
- equals(Object) - Method in class com.opentok.android.Session.Builder.IceServer
- equals(Object) - Method in class com.opentok.android.Stream
- equals(Object) - Method in class com.opentok.android.VideoUtils.Size
-
Checks to see if this Size object has the same dimensions as the Size object passed in.
- errorCode - Variable in class com.opentok.android.OpentokError
- errorDomain - Variable in class com.opentok.android.OpentokError
- errorMessage - Variable in class com.opentok.android.OpentokError
- exception - Variable in class com.opentok.android.OpentokError
- expectedDelay - Variable in class com.opentok.android.BaseVideoCapturer.CaptureSettings
-
The estimated capture delay, in milliseconds, of the video.
F
- finalize() - Method in class com.opentok.android.BaseAudioDevice
- finalize() - Method in class com.opentok.android.BaseVideoRenderer.Frame
- finalize() - Method in class com.opentok.android.Connection
- finalize() - Method in class com.opentok.android.PublisherKit.AudioTransformer
-
Called by the garbage collector when it determines that there are no more references to the VideoTransformer object.
- finalize() - Method in class com.opentok.android.PublisherKit
-
Called by the garbage collector when it determines that there are no more references to the PublisherKit object.
- finalize() - Method in class com.opentok.android.PublisherKit.VideoTransformer
-
Called by the garbage collector when it determines that there are no more references to the VideoTransformer object.
- finalize() - Method in class com.opentok.android.Session
-
Called by the garbage collector when it determines that there are no more references to the Session object.
- finalize() - Method in class com.opentok.android.Stream
- finalize() - Method in class com.opentok.android.SubscriberKit
-
Called by the garbage collector on an SubscriberKit object when garbage collection determines that there are no more references to the object.
- forceMuteAll(Iterable<Stream>) - Method in class com.opentok.android.Session
-
Forces all publishers in the session (except for those publishing excluded streams) to mute audio.
- forceMuteStream(Stream) - Method in class com.opentok.android.Session
-
Forces the publisher of a specified stream to mute its audio.
- format - Variable in class com.opentok.android.BaseVideoCapturer.CaptureSettings
-
The pixel format.
- format - Variable in class com.opentok.android.BaseVideoRenderer.Frame
- fps - Variable in class com.opentok.android.BaseVideoCapturer.CaptureSettings
-
The estimated number of frames per second in the video.
- FPS_1 - com.opentok.android.Publisher.CameraCaptureFrameRate
-
1 frame per second.
- FPS_15 - com.opentok.android.Publisher.CameraCaptureFrameRate
-
15 frames per second.
- FPS_30 - com.opentok.android.Publisher.CameraCaptureFrameRate
-
30 frames per second.
- FPS_7 - com.opentok.android.Publisher.CameraCaptureFrameRate
-
7 frames per second.
- Frame() - Constructor for class com.opentok.android.BaseVideoRenderer.Frame
- frameRate(Publisher.CameraCaptureFrameRate) - Method in class com.opentok.android.Publisher.Builder
-
Sets the desired frame rate of the published video.
- fromTypeCode(int) - Static method in enum com.opentok.android.OpentokError.ErrorCode
-
Build Type from error code.
G
- getActive() - Method in class com.opentok.android.MuteForcedInfo
-
Whether the moderator has muted streams in the session (
true
) or disabled the mute state in the session (false
). - getAudioBus() - Method in class com.opentok.android.BaseAudioDevice
-
Gets the AudioBus instance that this audio device uses.
- getAudioDevice() - Static method in class com.opentok.android.AudioDeviceManager
-
Gets the
BaseAudioDevice
instance. - getAudioFallbackEnabled() - Method in class com.opentok.android.PublisherKit
-
Deprecated.
- getAudioVolume() - Method in class com.opentok.android.SubscriberKit
-
Returns the audio volume, between 0 and 100, of the subscriber.
- getBitsPerSample() - Method in class com.opentok.android.AudioData
-
The number of bits in each sample.
- getBluetoothState() - Method in class com.opentok.android.BaseAudioDevice
-
Returns
BaseAudioDevice.BluetoothState.Connected
if there is a Bluetooth device and audio is being rendered to this device. - getBuffer() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Returns the byte buffer containing the video frame data, which is in I420 format.
- getCameraId() - Method in class com.opentok.android.Publisher
-
Deprecated.
- getCameraIndex() - Method in interface com.opentok.android.BaseVideoCapturer.CaptureSwitch
-
Defines the behavior of the deprecated
Publisher.getCameraId()
method for a Publisher object that uses the custom video capturer. - getCapabilities() - Method in class com.opentok.android.Session
-
Indicates whether the client can publish and subscribe to streams in the session, based on the role assigned to the token used to connect to the session.
- getCapturer() - Method in class com.opentok.android.PublisherKit
-
Returns the video capturer used by this publisher.
- getCaptureSettings() - Method in class com.opentok.android.BaseAudioDevice
-
Returns the AudioSettings object defining the audio capture settings used by this device.
- getCaptureSettings() - Method in class com.opentok.android.BaseVideoCapturer
-
Returns the settings for the video capturer.
- getConnection() - Method in class com.opentok.android.Session
-
Returns the
Connection
corresponding to this client's connection to this Session. - getConnection() - Method in class com.opentok.android.Stream
-
Returns the
Connection
object corresponding to this Stream. - getConnectionId() - Method in class com.opentok.android.Connection
- getCreationTime() - Method in class com.opentok.android.Connection
- getCreationTime() - Method in class com.opentok.android.Stream
-
Returns the time when this stream first joined the OpenTok session.
- getData() - Method in class com.opentok.android.Connection
- getErrorCode() - Method in enum com.opentok.android.OpentokError.ErrorCode
-
Returns errorCode.
- getErrorCode() - Method in class com.opentok.android.OpentokError
-
Returns the error code.
- getErrorDomain() - Method in class com.opentok.android.OpentokError
-
Returns the error domain.
- getEstimatedCaptureDelay() - Method in class com.opentok.android.BaseAudioDevice
-
The estimated capturing delay in ms.
- getEstimatedRenderDelay() - Method in class com.opentok.android.BaseAudioDevice
-
Returns the estimated rendering delay in ms.
- getException() - Method in class com.opentok.android.OpentokError
- getFormat() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Gets the format of the video frame.
- getHeight() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Returns the height of the video frame, in pixels.
- getInstalledCaCertificates() - Static method in class com.opentok.android.CaCertificates
- getMessage() - Method in class com.opentok.android.OpentokError
- getMetadata() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Returns the metadata associated with the frame if any, as a byte array.
- getName() - Method in class com.opentok.android.PublisherKit
-
The stream name.
- getName() - Method in class com.opentok.android.Stream
-
The name of the stream.
- getNumberOfChannels() - Method in class com.opentok.android.AudioData
-
The number of audio channels.
- getNumberOfSamples() - Method in class com.opentok.android.AudioData
-
The number of samples.
- getNumChannels() - Method in class com.opentok.android.BaseAudioDevice.AudioSettings
-
Returns the number of audio channels.
- getOutputMode() - Method in class com.opentok.android.BaseAudioDevice
-
Returns the audio output mode for the app.
- getPreferredFrameRate() - Method in class com.opentok.android.SubscriberKit
-
Returns the preferred frame rate for the subscriber's stream.
- getPreferredResolution() - Method in class com.opentok.android.SubscriberKit
-
Returns the preferred resolution for the subscriber's stream.
- getPublishAudio() - Method in class com.opentok.android.PublisherKit
-
Whether the Publisher is publishing audio (
true
) or not (false
). - getPublishCaptions() - Method in class com.opentok.android.PublisherKit
-
Whether the Publisher is publishing captions (
true
) or not (false
). - getPublisherVideoType() - Method in class com.opentok.android.PublisherKit
-
Returns the type of video for this publisher.
- getPublishVideo() - Method in class com.opentok.android.PublisherKit
-
Whether the Publisher is publishing video (
true
) or not (false
). - getRenderer() - Method in class com.opentok.android.PublisherKit
-
Returns the video renderer for this publisher.
- getRenderer() - Method in class com.opentok.android.SubscriberKit
-
Returns the video renderer for this subscriber.
- getRenderSettings() - Method in class com.opentok.android.BaseAudioDevice
-
Returns the AudioSettings object defining the audio rendering settings used by this device.
- getRtcStatsReport() - Method in class com.opentok.android.PublisherKit
-
Gets the RTC stats report for the publisher.
- getRtcStatsReport() - Method in class com.opentok.android.SubscriberKit
-
Gets the RTC stats report for the subscriber.
- getSampleBuffer() - Method in class com.opentok.android.AudioData
-
The buffer with the audio samples.
- getSampleRate() - Method in class com.opentok.android.AudioData
-
The bitrate of the samples, in bits per second.
- getSampleRate() - Method in class com.opentok.android.BaseAudioDevice.AudioSettings
-
Returns the sample rate (in samples per second).
- getSession() - Method in class com.opentok.android.PublisherKit
-
Returns the
Session
bound to this Publisher instance. - getSession() - Method in class com.opentok.android.Stream
-
Deprecated.
- getSession() - Method in class com.opentok.android.SubscriberKit
-
Returns the
Session
that the subscriber is bound to (by calling theconnect()
method of the Session object). - getSessionId() - Method in class com.opentok.android.Session
-
Returns the Session ID passed in during instantiation.
- getStream() - Method in class com.opentok.android.PublisherKit
-
Returns the stream object corresponding the the Publisher's stream.
- getStream() - Method in class com.opentok.android.SubscriberKit
-
Returns the
Stream
that this instance is bound to. - getStreamId() - Method in class com.opentok.android.Stream
-
Gets a unique identifier for this stream.
- getStreamVideoType() - Method in class com.opentok.android.Stream
- getSubscribeToAudio() - Method in class com.opentok.android.SubscriberKit
-
Whether the Subscriber is subscribing to audio or not.
- getSubscribeToCaptions() - Method in class com.opentok.android.SubscriberKit
-
Whether the Subscriber is subscribing to captions or not.
- getSubscribeToVideo() - Method in class com.opentok.android.SubscriberKit
-
Whether the Subscriber is subscribing to audio or not.
- getSupportedCodecs(Context) - Static method in class com.opentok.android.MediaUtils
- getUplane() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Returns the byte buffer containing the U plane video frame data.
- getUVplaneSize() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Returns the U and V plane size.
- getUvStride() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Returns the value of U or V stride.
- getValue() - Method in enum com.opentok.android.BaseVideoCapturer.VideoContentHint
- getValue() - Method in enum com.opentok.android.MediaUtils.VideoCodecType
- getValue(int) - Static method in enum com.opentok.android.MediaUtils.VideoCodecType
- getVideoContentHint() - Method in class com.opentok.android.BaseVideoCapturer
-
Returns the video content hint setting.
- getVideoHeight() - Method in class com.opentok.android.Stream
-
The height of the stream, in pixels.
- getVideoType() - Method in enum com.opentok.android.PublisherKit.PublisherKitVideoType
- getVideoType() - Method in enum com.opentok.android.Stream.StreamVideoType
- getVideoWidth() - Method in class com.opentok.android.Stream
-
The width of the stream, in pixels.
- getView() - Method in class com.opentok.android.BaseVideoRenderer
-
Returns the View containing the video.
- getView() - Method in class com.opentok.android.PublisherKit
-
Returns the android.view.View object that contains the Publisher video.
- getView() - Method in class com.opentok.android.SubscriberKit
-
Returns the android.view.View object that contains the Subscriber video.
- getVplane() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Returns the byte buffer containing the V plane video frame data.
- getWidth() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Returns the width of the video frame, in pixels.
- getYplane() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Returns the byte buffer containing the Y plane video frame data.
- getYplaneSize() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Returns the Y plane size.
- getYstride() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Returns the value of Y stride.
H
- handler - Variable in class com.opentok.android.PublisherKit
- Handset - com.opentok.android.BaseAudioDevice.OutputMode
-
Defines the handset audio output mode setting for the
BaseAudioDevice.setOutputMode(OutputMode mode)
method. - hasAudio() - Method in class com.opentok.android.Stream
-
Whether this stream has audio (
true
) or not (false
). - hasCaptions() - Method in class com.opentok.android.Stream
-
Whether this stream has captions (
true
) or not (false
). - hashCode() - Method in class com.opentok.android.Connection
- hashCode() - Method in class com.opentok.android.Stream
- hasVideo() - Method in class com.opentok.android.Stream
-
Whether this stream has video (
true
) or not (false
). - height - Variable in class com.opentok.android.BaseVideoCapturer.CaptureSettings
-
The height of the video, in pixels.
- height - Variable in class com.opentok.android.BaseVideoRenderer.Frame
- height - Variable in class com.opentok.android.VideoUtils.Size
-
The height, in pixels.
- HIGH - com.opentok.android.Publisher.CameraCaptureResolution
-
HD resolution (1280x720) or the closest resolution supported on the device.
- HIGH_1080P - com.opentok.android.Publisher.CameraCaptureResolution
-
1080p resolution (1920x1080), the highest available camera capture resolution supported in the OpenTok iOS SDK or the closest resolution supported on the device.
I
- IceServer(String, String, String) - Constructor for class com.opentok.android.Session.Builder.IceServer
-
This is part of the configurable TURN feature.
- init() - Method in class com.opentok.android.BaseVideoCapturer
-
Initializes the video capturer.
- initCapturer() - Method in class com.opentok.android.BaseAudioDevice
-
Requests the audio device to initialize itself for audio sampling.
- initRenderer() - Method in class com.opentok.android.BaseAudioDevice
-
Requests the audio device to initialize itself for rendering.
- internalBuffer - Variable in class com.opentok.android.BaseVideoRenderer.Frame
- InvalidEncryptionSecret - com.opentok.android.OpentokError.ErrorCode
-
Invalid encryption secret
- InvalidSessionId - com.opentok.android.OpentokError.ErrorCode
-
Unable to connect: an invalid session ID was provided.
- isCamera2Capable() - Method in class com.opentok.android.Session.SessionOptions
-
Deprecated.
- isCaptureStarted() - Method in class com.opentok.android.BaseVideoCapturer
-
Whether video is being captured (true) or not (false).
- isHwDecodingSupported() - Method in class com.opentok.android.Session.ConfigurableSessionOptions
- isHwDecodingSupported() - Method in class com.opentok.android.Session.SessionOptions
-
Deprecated.
- isHwDecodingSupported() - Method in interface com.opentok.android.Session.SessionOptionsProvider
-
Deprecated.
- isMirroredX() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Whether the video frame is mirrored about the x-axis (
true
) or not (false
).
J
- jsonArrayOfReports - Variable in class com.opentok.android.PublisherKit.PublisherRtcStats
-
A JSON array of RTC stats reports for the media stream.
L
- LOW - com.opentok.android.Publisher.CameraCaptureResolution
-
The lowest available camera capture resolution supported in the OpenTok Android SDK (352x288) or the closest resolution supported on the device.
M
- MediaTransformerCustomCallbackNotProvided - com.opentok.android.OpentokError.ErrorCode
- MediaTransformerInternalError - com.opentok.android.OpentokError.ErrorCode
- MediaTransformerInvalidType - com.opentok.android.OpentokError.ErrorCode
- MediaTransformerModelNotFound - com.opentok.android.OpentokError.ErrorCode
- MediaTransformerNameNotProvided - com.opentok.android.OpentokError.ErrorCode
- MediaTransformerOpenTokTransformersLibraryNotLoaded - com.opentok.android.OpentokError.ErrorCode
- MediaTransformerOpenTokTransformersSymbolNotFound - com.opentok.android.OpentokError.ErrorCode
- MediaTransformerPropertiesNotProvided - com.opentok.android.OpentokError.ErrorCode
- MediaUtils - Class in com.opentok.android
-
Includes a static
MediaUtils.getSupportedCodecs(Context context)
method to discover which video codecs are supported on the device. - MediaUtils() - Constructor for class com.opentok.android.MediaUtils
- MediaUtils.SupportedCodecs - Class in com.opentok.android
-
An object providing lists of video codecs for encoding and decoding video that are supported on the device.
- MediaUtils.VideoCodecType - Enum in com.opentok.android
-
An enum of video codec types.
- MEDIUM - com.opentok.android.Publisher.CameraCaptureResolution
-
VGA resolution (640x480) or the closest resolution supported on the device.
- metadata - Variable in class com.opentok.android.BaseVideoRenderer.Frame
- mirrored - Variable in class com.opentok.android.BaseVideoRenderer.Frame
- mirrorInLocalRender - Variable in class com.opentok.android.BaseVideoCapturer.CaptureSettings
-
Whether the frame should appear mirrored in the local renderer.
- MJPEG - Static variable in class com.opentok.android.BaseVideoCapturer
-
Defines the value for the MJPEG pixel format used by the
BaseVideoCapturer.CaptureSettings.format
property. - MOTION - com.opentok.android.BaseVideoCapturer.VideoContentHint
-
The track should be treated as if it contains video where motion is important.
- MuteForcedInfo - Class in com.opentok.android
-
Defines the
info
parameter of theSession.onMuteForced(MuteForcedInfo info)
andSession.onMuteForced(MuteForcedInfo info)
methods. - MuteForcedInfo(boolean) - Constructor for class com.opentok.android.MuteForcedInfo
- muteListener - Variable in class com.opentok.android.PublisherKit
- muteListener - Variable in class com.opentok.android.Session
N
- name(String) - Method in class com.opentok.android.Publisher.Builder
- name(String) - Method in class com.opentok.android.PublisherKit.Builder
-
Sets the name of the published video.
- NO_PREFERRED_FRAMERATE - Static variable in class com.opentok.android.SubscriberKit
-
Defines a reset value to passed into the
SubscriberKit.setPreferredFrameRate(float preferredFrameRate)
method. - NO_PREFERRED_RESOLUTION - Static variable in class com.opentok.android.SubscriberKit
-
Defines a reset value to passed into the
SubscriberKit.setPreferredResolution(VideoUtils.Size preferredResolution)
method. - NoMessagingServer - com.opentok.android.OpentokError.ErrorCode
-
There was an error connecting to the OpenTok messaging server.
- NONE - com.opentok.android.BaseVideoCapturer.VideoContentHint
-
No hint is provided (the default).
- NV12 - Static variable in class com.opentok.android.BaseVideoCapturer
-
Defines the value for the NV12 pixel format used by the
BaseVideoCapturer.CaptureSettings.format
property. - NV21 - Static variable in class com.opentok.android.BaseVideoCapturer
-
Defines the value for the NV21 pixel format used by the
BaseVideoCapturer.CaptureSettings.format
property.
O
- onArchiveStarted(Session, String, String) - Method in interface com.opentok.android.Session.ArchiveListener
-
Called when an archive of the session starts recording.
- onArchiveStarted(String, String) - Method in class com.opentok.android.Session
-
Called when an archive of the session starts recording.
- onArchiveStopped(Session, String) - Method in interface com.opentok.android.Session.ArchiveListener
-
Called when an archive of the session stops being recorded.
- onArchiveStopped(String) - Method in class com.opentok.android.Session
-
Called when an archive of the session stops being recorded.
- onAudioDisabled() - Method in class com.opentok.android.SubscriberKit
-
Called when the subscriber's stream audio has been disabled
- onAudioDisabled(SubscriberKit) - Method in interface com.opentok.android.SubscriberKit.StreamListener
-
Called when the subscriber stops receiving audio.
- onAudioEnabled() - Method in class com.opentok.android.SubscriberKit
-
Called when the subscriber's stream has the audio enabled.
- onAudioEnabled(SubscriberKit) - Method in interface com.opentok.android.SubscriberKit.StreamListener
-
Called when the subscriber's audio stream starts (when there previously was no audio) or resumes (after audio was disabled).
- onAudioLevelUpdated(float) - Method in class com.opentok.android.PublisherKit
-
Called periodically to report the audio level of the publisher.
- onAudioLevelUpdated(float) - Method in class com.opentok.android.SubscriberKit
- onAudioLevelUpdated(PublisherKit, float) - Method in interface com.opentok.android.PublisherKit.AudioLevelListener
-
Called periodically to report the audio level of the publisher.
- onAudioLevelUpdated(SubscriberKit, float) - Method in interface com.opentok.android.SubscriberKit.AudioLevelListener
-
Called periodically to report the audio level of the subscriber.
- onAudioStats(PublisherKit, PublisherKit.PublisherAudioStats[]) - Method in interface com.opentok.android.PublisherKit.AudioStatsListener
-
Called periodically to report audio statistics for the publisher.
- onAudioStats(SubscriberKit, SubscriberKit.SubscriberAudioStats) - Method in interface com.opentok.android.SubscriberKit.AudioStatsListener
-
Called periodically to report audio statistics for the subscriber.
- onCameraChanged(int) - Method in class com.opentok.android.Publisher
-
Invoked when the publisher changes the active camera.
- onCameraChanged(Publisher, int) - Method in interface com.opentok.android.Publisher.CameraListener
-
Invoked when the publisher changes the active camera.
- onCameraError(OpentokError) - Method in class com.opentok.android.Publisher
-
Invoked when there is an error accessing the camera.
- onCameraError(Publisher, OpentokError) - Method in interface com.opentok.android.Publisher.CameraListener
-
Invoked when there is an error accessing the camera.
- onCaptionText(SubscriberKit, String, boolean) - Method in interface com.opentok.android.SubscriberKit.CaptionsListener
-
Called with the new caption text of the stream's audio.
- onCaptionText(String, boolean) - Method in class com.opentok.android.SubscriberKit
- onConnected() - Method in class com.opentok.android.Session
-
Invoked when the client connects to the OpenTok session.
- onConnected() - Method in class com.opentok.android.SubscriberKit
-
Invoked when the instance has successfully connected to the stream and begins playing media.
- onConnected(Session) - Method in interface com.opentok.android.Session.SessionListener
-
Invoked when the client connects to the OpenTok session.
- onConnected(SubscriberKit) - Method in interface com.opentok.android.SubscriberKit.SubscriberListener
-
Invoked when the instance has successfully connected to the stream and begins playing media.
- onConnectionCreated(Connection) - Method in class com.opentok.android.Session
-
Invoked when another client connects to the session.
- onConnectionCreated(Session, Connection) - Method in interface com.opentok.android.Session.ConnectionListener
-
Invoked when another client connects to the session.
- onConnectionDestroyed(Connection) - Method in class com.opentok.android.Session
-
Invoked when another client leaves the session.
- onConnectionDestroyed(Session, Connection) - Method in interface com.opentok.android.Session.ConnectionListener
-
Invoked when another client leaves the session.
- onDisconnected() - Method in class com.opentok.android.Session
-
Invoked when the client is no longer connected to the OpenTok session.
- onDisconnected() - Method in class com.opentok.android.SubscriberKit
-
Deprecated.
- onDisconnected(Session) - Method in interface com.opentok.android.Session.SessionListener
-
Invoked when the client is no longer connected to the OpenTok session.
- onDisconnected(SubscriberKit) - Method in interface com.opentok.android.SubscriberKit.StreamListener
-
Called when the subscriber's stream has been interrupted.
- onDisconnected(SubscriberKit) - Method in interface com.opentok.android.SubscriberKit.SubscriberListener
-
Invoked when the instance has successfully destroyed.
- onError(OpentokError) - Method in class com.opentok.android.PublisherKit
-
Invoked when the publisher fails.
- onError(OpentokError) - Method in class com.opentok.android.Session
-
Invoked when something goes wrong when connecting or connected to the session.
- onError(OpentokError) - Method in class com.opentok.android.SubscriberKit
-
Invoked when a subscriber has failed to connect to the OpenTok server.
- onError(PublisherKit, OpentokError) - Method in interface com.opentok.android.PublisherKit.PublisherListener
-
Invoked when the publisher fails.
- onError(Session, OpentokError) - Method in interface com.opentok.android.Session.SessionListener
-
Invoked when something goes wrong when connecting or connected to the session.
- onError(SubscriberKit, OpentokError) - Method in interface com.opentok.android.SubscriberKit.SubscriberListener
-
Invoked when a subscriber reports an error.
- onFrame(BaseVideoRenderer.Frame) - Method in class com.opentok.android.BaseVideoRenderer
-
Called when a frame is rendered for the stream.
- onMuteForced() - Method in class com.opentok.android.PublisherKit
-
Invoked when a moderator has forced this publisher to mute audio.
- onMuteForced(MuteForcedInfo) - Method in class com.opentok.android.Session
-
Invoked when a moderator mutes streams in the session or disables the mute state in the session.
- onMuteForced(PublisherKit) - Method in interface com.opentok.android.PublisherKit.MuteListener
-
Invoked when a moderator has forced this publisher to mute audio.
- onMuteForced(Session, MuteForcedInfo) - Method in interface com.opentok.android.Session.MuteListener
-
Invoked when a moderator mutes streams in the session or disables the mute state in the session.
- onPause() - Method in class com.opentok.android.BaseAudioDevice
-
Call this method when the activity pauses.
- onPause() - Method in class com.opentok.android.BaseVideoCapturer
-
Call this method when the activity pauses.
- onPause() - Method in class com.opentok.android.BaseVideoRenderer
-
Call this method when the activity pauses.
- onPause() - Method in class com.opentok.android.PublisherKit
-
Do not call directly; call
Session.onPause()
instead. - onPause() - Method in class com.opentok.android.Session
-
Call this method when the app's activity pauses.
- onPause() - Method in class com.opentok.android.SubscriberKit
-
Do not call directly; call
Session.onPause()
instead. - onReconnected() - Method in class com.opentok.android.Session
-
Invoked when the local client has reconnected to the OpenTok session after its network connection was lost temporarily.
- onReconnected(Session) - Method in interface com.opentok.android.Session.ReconnectionListener
-
Invoked when the local client has reconnected to the OpenTok session after its network connection was lost temporarily.
- onReconnected(SubscriberKit) - Method in interface com.opentok.android.SubscriberKit.StreamListener
-
Called when the subscriber's stream has resumed, after the
SubscriberKit.SubscriberListener.onDisconnected(SubscriberKit subscriber)
method is called. - onReconnecting() - Method in class com.opentok.android.Session
-
Invoked when the local client has lost its connection to an OpenTok session and is trying to reconnect.
- onReconnecting(Session) - Method in interface com.opentok.android.Session.ReconnectionListener
-
Invoked when the local client has lost its connection to an OpenTok session and is trying to reconnect.
- onRestart() - Method in class com.opentok.android.BaseVideoCapturer
-
Call this method when the activity is restarted.
- onRestart() - Method in class com.opentok.android.PublisherKit
-
Restarts publisher resources that were previously released by calling the
PublisherKit.onStop()
method. - onResume() - Method in class com.opentok.android.BaseAudioDevice
-
Call this method when the activity resumes.
- onResume() - Method in class com.opentok.android.BaseVideoCapturer
-
Call this method when the activity resumes.
- onResume() - Method in class com.opentok.android.BaseVideoRenderer
-
Call this method when the activity resumes.
- onResume() - Method in class com.opentok.android.PublisherKit
-
Do not call directly; call
Session.onResume()
instead. - onResume() - Method in class com.opentok.android.Session
-
Call this method when the app's activity resumes.
- onResume() - Method in class com.opentok.android.SubscriberKit
-
Do not call directly; call
Session.onResume()
instead. - onRtcStatsReport(PublisherKit.PublisherRtcStats[]) - Method in class com.opentok.android.PublisherKit
-
Called when the publisher's RTC stats report is available in response to a call to
PublisherKit.getRtcStatsReport()
. - onRtcStatsReport(PublisherKit, PublisherKit.PublisherRtcStats[]) - Method in interface com.opentok.android.PublisherKit.PublisherRtcStatsReportListener
-
Called when the RTC statistics for the publisher are available, in response to a call to the
PublisherKit.getRtcStatsReport()
method. - onRtcStatsReport(SubscriberKit, String) - Method in interface com.opentok.android.SubscriberKit.SubscriberRtcStatsReportListener
-
Called when the RTC statistics for the subscriber are available, in response to a call to the SubscriberKit#getRtcStatsReport() method.
- onRtcStatsReport(String) - Method in class com.opentok.android.SubscriberKit
-
Called when the subscriber's RTC stats report is available in response to a call to
SubscriberKit.getRtcStatsReport()
. - onSignalReceived(Session, String, String, Connection) - Method in interface com.opentok.android.Session.SignalListener
-
Called when a signal is received in the session.
- onSignalReceived(String, String, Connection) - Method in class com.opentok.android.Session
-
Called when a signal is received in the session.
- onStop() - Method in class com.opentok.android.BaseVideoCapturer
-
Call this method when the activity stops.
- onStop() - Method in class com.opentok.android.PublisherKit
-
Releases resources tied to the publisher.
- onStreamCreated(PublisherKit, Stream) - Method in interface com.opentok.android.PublisherKit.PublisherListener
-
Invoked when the publisher's stream is created.
- onStreamCreated(Stream) - Method in class com.opentok.android.PublisherKit
-
Invoked when the publisher's stream is created.
- onStreamDestroyed(PublisherKit, Stream) - Method in interface com.opentok.android.PublisherKit.PublisherListener
-
Invoked when the publisher's stream is destroyed.
- onStreamDestroyed(Stream) - Method in class com.opentok.android.PublisherKit
-
Invoked when the publisher's stream is destroyed.
- onStreamDisconnected() - Method in class com.opentok.android.SubscriberKit
-
Called when the subscriber's stream has been interrupted.
- onStreamDropped(Session, Stream) - Method in interface com.opentok.android.Session.SessionListener
-
Invoked when another client stops publishing a stream to this OpenTok session.
- onStreamDropped(Stream) - Method in class com.opentok.android.Session
-
Invoked when another client stops publishing a stream to this OpenTok session.
- onStreamHasAudioChanged(Session, Stream, boolean) - Method in interface com.opentok.android.Session.StreamPropertiesListener
-
Called when a stream in the session changes between having audio and not having audio.
- onStreamHasAudioChanged(Stream, int) - Method in class com.opentok.android.Session
-
Called when a stream in the session changes between having audio and not having audio.
- onStreamHasCaptionsChanged(Session, Stream, boolean) - Method in interface com.opentok.android.Session.StreamCaptionsPropertiesListener
-
Called when streams in the session changes value between having captions and not having captions.
- onStreamHasCaptionsChanged(Stream, int) - Method in class com.opentok.android.Session
-
Called when a stream in the session changes between having captions and not having captions.
- onStreamHasVideoChanged(Session, Stream, boolean) - Method in interface com.opentok.android.Session.StreamPropertiesListener
-
Called when a stream in the session changes between having video and not having video.
- onStreamHasVideoChanged(Stream, int) - Method in class com.opentok.android.Session
-
Called when a stream in the session changes between having video and not having video.
- onStreamReceived(Session, Stream) - Method in interface com.opentok.android.Session.SessionListener
-
Invoked when a there is a new stream published by another client in this OpenTok session.
- onStreamReceived(Stream) - Method in class com.opentok.android.Session
-
Invoked when a there is a new stream published by another client in this OpenTok session.
- onStreamReconnected() - Method in class com.opentok.android.SubscriberKit
-
Called when the subscriber's stream has resumed, after the
SubscriberKit.onStreamDisconnected()
method is called. - onStreamVideoDimensionsChanged(Session, Stream, int, int) - Method in interface com.opentok.android.Session.StreamPropertiesListener
-
Called when the video dimensions of a stream in the session change.
- onStreamVideoDimensionsChanged(Stream, int, int) - Method in class com.opentok.android.Session
-
Called when the video dimensions of a stream in the session change.
- onStreamVideoTypeChanged(Session, Stream, Stream.StreamVideoType) - Method in interface com.opentok.android.Session.StreamPropertiesListener
-
Called when the video type of a stream in the session change.
- onStreamVideoTypeChanged(Stream, int) - Method in class com.opentok.android.Session
-
Called when the video type of a stream in the session change.
- onTransform(AudioData) - Method in interface com.opentok.android.PublisherKit.CustomAudioTransformer
-
Called when audio data is available to be transformed.
- onTransform(BaseVideoRenderer.Frame) - Method in interface com.opentok.android.PublisherKit.CustomVideoTransformer
-
Called when a video frame is available to be transformed.
- onVideoDataReceived() - Method in class com.opentok.android.SubscriberKit
-
Invoked when an subscriber initially receives video data.
- onVideoDataReceived(SubscriberKit) - Method in interface com.opentok.android.SubscriberKit.VideoListener
-
Invoked when an subscriber initially receives video data.
- onVideoDisabled(PublisherKit, String) - Method in interface com.opentok.android.PublisherKit.VideoListener
-
Called when the publisher stops sending video.
- onVideoDisabled(SubscriberKit, String) - Method in interface com.opentok.android.SubscriberKit.VideoListener
-
Called when the subscriber stops receiving video.
- onVideoDisabled(String) - Method in class com.opentok.android.SubscriberKit
-
Called when the subscriber stops receiving video.
- onVideoDisableWarning() - Method in class com.opentok.android.SubscriberKit
-
Called when the OpenTok Media Router determines that the stream quality has degraded and the video will be disabled if the quality degrades further.
- onVideoDisableWarning(PublisherKit) - Method in interface com.opentok.android.PublisherKit.VideoListener
-
Called when the publisher determines that the network congestion level has degraded and the video will be disabled if the quality degrades further.
- onVideoDisableWarning(SubscriberKit) - Method in interface com.opentok.android.SubscriberKit.VideoListener
-
Called when the OpenTok Media Router determines that the stream quality has degraded and the video will be disabled if the quality degrades further.
- onVideoDisableWarningLifted() - Method in class com.opentok.android.SubscriberKit
-
Called when the OpenTok Media Router determines that the stream quality has improved to the point at which the video being disabled is not an immediate risk.
- onVideoDisableWarningLifted(PublisherKit) - Method in interface com.opentok.android.PublisherKit.VideoListener
-
Called when the publisher determines that the network congestion level has improved to the point at which the video being disabled is not an immediate risk.
- onVideoDisableWarningLifted(SubscriberKit) - Method in interface com.opentok.android.SubscriberKit.VideoListener
-
Called when the OpenTok Media Router determines that the stream quality has improved to the point at which the video being disabled is not an immediate risk.
- onVideoEnabled(PublisherKit, String) - Method in interface com.opentok.android.PublisherKit.VideoListener
-
Called when the publisher's video stream resumes (after video was disabled).
- onVideoEnabled(SubscriberKit, String) - Method in interface com.opentok.android.SubscriberKit.VideoListener
-
Called when the subscriber's video stream starts (when there previously was no video) or resumes (after video was disabled).
- onVideoEnabled(String) - Method in class com.opentok.android.SubscriberKit
-
Called when the subscriber's video stream starts (when there previously was no video) or resumes (after video was disabled).
- onVideoPropertiesChanged(boolean) - Method in class com.opentok.android.BaseVideoRenderer
-
Called when the stream changes between having video and not having video (audio-only).
- onVideoStats(PublisherKit, PublisherKit.PublisherVideoStats[]) - Method in interface com.opentok.android.PublisherKit.VideoStatsListener
-
Called periodically to report video statistics for the publisher.
- onVideoStats(SubscriberKit, SubscriberKit.SubscriberVideoStats) - Method in interface com.opentok.android.SubscriberKit.VideoStatsListener
-
Called periodically to report video statistics for the subscriber.
- OpentokError - Class in com.opentok.android
-
Defines errors thrown by the OpenTok Android SDK.
- OpentokError(OpentokError.Domain, int, Exception) - Constructor for class com.opentok.android.OpentokError
-
Builds an OpentokError based on its domain, error code and message.
- OpentokError(OpentokError.Domain, int, String) - Constructor for class com.opentok.android.OpentokError
-
Builds an OpentokError based on its domain, error code and message.
- OpentokError.Domain - Enum in com.opentok.android
-
Defines error domains values for OpentokError objects.
- OpentokError.ErrorCode - Enum in com.opentok.android
-
Defines error code values for OpentokError objects.
- OpenTokTransformersCustomRadiusPropertyNotProvided - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersImageFilePathNotFound - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersImageFilePathPropertyNotProvided - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersInternalError - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersInvalidCustomRadiusProperty - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersInvalidName - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersInvalidParam - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersInvalidPropertiesFormat - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersInvalidRadiusProperty - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersMlTransformerInitError - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersModelFileNotFound - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersNameNotProvided - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersPropertiesNotProvided - com.opentok.android.OpentokError.ErrorCode
- OpenTokTransformersRadiusPropertyNotProvided - com.opentok.android.OpentokError.ErrorCode
P
- P2PSessionMaxParticipants - com.opentok.android.OpentokError.ErrorCode
-
A peer-to-peer enabled session can only have two participants.
- provideBufferFrame(ByteBuffer, int, int, int, int, boolean) - Method in class com.opentok.android.BaseVideoCapturer
-
Provide a frame of video as a byte buffer.
- provideBufferFrame(ByteBuffer, int, int, int, int, boolean, byte[]) - Method in class com.opentok.android.BaseVideoCapturer
-
Provide a frame of video as a byte buffer.
- provideBufferFramePlanar(ByteBuffer, ByteBuffer, ByteBuffer, int, int, int, int, int, int, int, int, int, boolean) - Method in class com.opentok.android.BaseVideoCapturer
-
Provide a frame of video as 3 bytebuffer planes.
- provideBufferFramePlanar(ByteBuffer, ByteBuffer, ByteBuffer, int, int, int, int, int, int, int, int, int, boolean, byte[]) - Method in class com.opentok.android.BaseVideoCapturer
-
Provide a frame of video as 3 bytebuffer planes.
- provideByteArrayFrame(byte[], int, int, int, int, boolean) - Method in class com.opentok.android.BaseVideoCapturer
-
Provide a frame of video as a byte array.
- provideByteArrayFrame(byte[], int, int, int, int, boolean, byte[]) - Method in class com.opentok.android.BaseVideoCapturer
-
Provide a frame of video as a byte array.
- provideIntArrayFrame(int[], int, int, int, int, boolean) - Method in class com.opentok.android.BaseVideoCapturer
-
Provide a frame of video as an array of integers.
- provideIntArrayFrame(int[], int, int, int, int, boolean, byte[]) - Method in class com.opentok.android.BaseVideoCapturer
-
Provide a frame of video as an array of integers.
- publish(PublisherKit) - Method in class com.opentok.android.Session
-
Starts a Publisher streaming to the session.
- Publisher - Class in com.opentok.android
-
Used to capture an audio-video stream from the device's microphone and camera for use in an OpenTok session.
- Publisher(Context) - Constructor for class com.opentok.android.Publisher
-
Deprecated.
- Publisher(Context, String) - Constructor for class com.opentok.android.Publisher
-
Deprecated.
- Publisher(Context, String, boolean, boolean) - Constructor for class com.opentok.android.Publisher
-
Deprecated.
- Publisher(Context, String, boolean, boolean, BaseVideoCapturer, Publisher.CameraCaptureResolution, Publisher.CameraCaptureFrameRate, BaseVideoRenderer) - Constructor for class com.opentok.android.Publisher
-
Deprecated.
- Publisher(Context, String, boolean, int, boolean, BaseVideoCapturer, Publisher.CameraCaptureResolution, Publisher.CameraCaptureFrameRate, BaseVideoRenderer, boolean, boolean) - Constructor for class com.opentok.android.Publisher
-
Deprecated.
- Publisher(Context, String, boolean, int, boolean, BaseVideoCapturer, Publisher.CameraCaptureResolution, Publisher.CameraCaptureFrameRate, BaseVideoRenderer, boolean, boolean, boolean, boolean) - Constructor for class com.opentok.android.Publisher
-
Creates a new Publisher object.
- Publisher(Context, String, BaseVideoCapturer) - Constructor for class com.opentok.android.Publisher
-
Deprecated.
- Publisher(Context, String, Publisher.CameraCaptureResolution, Publisher.CameraCaptureFrameRate) - Constructor for class com.opentok.android.Publisher
-
Deprecated.
- Publisher.Builder - Class in com.opentok.android
-
Used to build a
Publisher
object. - Publisher.CameraCaptureFrameRate - Enum in com.opentok.android
-
Defines values for the
frameRate
parameter of thePublisher.Builder.frameRate(Publisher.CameraCaptureFrameRate frameRate)
method. - Publisher.CameraCaptureResolution - Enum in com.opentok.android
-
Defines values for the
resolution
parameter of thePublisher.Builder.resolution(Publisher.CameraCaptureResolution resolution)
method. - Publisher.CameraListener - Interface in com.opentok.android
-
Monitors when the camera used by the publisher changes.
- publisherAudioFallbackEnabled(boolean) - Method in class com.opentok.android.Publisher.Builder
- publisherAudioFallbackEnabled(boolean) - Method in class com.opentok.android.PublisherKit.Builder
-
Whether the stream will use the publisher audio-fallback feature (
true
) or not (false
). - PublisherCameraAccessDenied - com.opentok.android.OpentokError.ErrorCode
- PublisherCannotAccessCamera - com.opentok.android.OpentokError.ErrorCode
- PublisherErrorDomain - com.opentok.android.OpentokError.Domain
-
The error pertains to a
Publisher
object. - PublisherInternalError - com.opentok.android.OpentokError.ErrorCode
-
Internal error when publishing.
- PublisherKit - Class in com.opentok.android
-
A publisher captures an audio-video stream from the sources you specify.
- PublisherKit(Context) - Constructor for class com.opentok.android.PublisherKit
-
Deprecated.
- PublisherKit(Context, String) - Constructor for class com.opentok.android.PublisherKit
-
Deprecated.
- PublisherKit(Context, String, boolean, boolean) - Constructor for class com.opentok.android.PublisherKit
-
Deprecated.
- PublisherKit(Context, String, boolean, boolean, BaseVideoCapturer, BaseVideoRenderer) - Constructor for class com.opentok.android.PublisherKit
-
Deprecated.
- PublisherKit(Context, String, boolean, int, boolean, BaseVideoCapturer, BaseVideoRenderer, boolean, boolean) - Constructor for class com.opentok.android.PublisherKit
-
Deprecated.
- PublisherKit(Context, String, boolean, int, boolean, BaseVideoCapturer, BaseVideoRenderer, boolean, boolean, boolean, boolean) - Constructor for class com.opentok.android.PublisherKit
-
Creates a new PublisherKit object.
- PublisherKit.AudioLevelListener - Interface in com.opentok.android
-
Monitors changes in the audio level of the publisher.
- PublisherKit.AudioStatsListener - Interface in com.opentok.android
-
Defines the listener object for getting publisher audio statistcs.
- PublisherKit.AudioTransformer - Class in com.opentok.android
-
A transformer for an audio stream.
- PublisherKit.Builder - Class in com.opentok.android
-
Used to build a
PublisherKit
object. - PublisherKit.CustomAudioTransformer - Interface in com.opentok.android
-
Defines a custom transformer for an audio stream, to be passed into the
AudioTransformer(String name, CustomAudioTransformer transformer)
constructor. - PublisherKit.CustomVideoTransformer - Interface in com.opentok.android
-
Defines a custom transformer for a video stream, to be passed into the
constructor.
- PublisherKit.MuteListener - Interface in com.opentok.android
-
Monitors when a moderator has forced this publisher to mute audio.
- PublisherKit.PublisherAudioStats - Class in com.opentok.android
-
Defines audio statistics for a publisher.
- PublisherKit.PublisherKitVideoType - Enum in com.opentok.android
-
Defines values for the
PublisherKit.setPublisherVideoType(PublisherKitVideoType type)
method. - PublisherKit.PublisherListener - Interface in com.opentok.android
-
Monitors when a publisher starts and stops streaming to the session.
- PublisherKit.PublisherRtcStats - Class in com.opentok.android
-
Represents RTC statistics for a media stream published by the publisher.
- PublisherKit.PublisherRtcStatsReportListener - Interface in com.opentok.android
-
Defines the listener object for getting publisher RTC stats reports.
- PublisherKit.PublisherVideoStats - Class in com.opentok.android
-
Defines video statistics for a publisher.
- PublisherKit.VideoListener - Interface in com.opentok.android
-
Monitors when the publisher starts and stops receiving video data.
- PublisherKit.VideoStatsListener - Interface in com.opentok.android
-
Defines the listener object for getting publisher video statistcs.
- PublisherKit.VideoTransformer - Class in com.opentok.android
-
A transformer for a video stream.
- PublisherKitVideoTypeCamera - com.opentok.android.PublisherKit.PublisherKitVideoType
-
Defines the camera video mode setting for the
PublisherKit.setPublisherVideoType(PublisherKitVideoType type)
method. - PublisherKitVideoTypeScreen - com.opentok.android.PublisherKit.PublisherKitVideoType
-
Defines the screen video mode setting for the
PublisherKit.setPublisherVideoType(PublisherKitVideoType type)
method. - publisherListener - Variable in class com.opentok.android.PublisherKit
- PublisherRtcStats() - Constructor for class com.opentok.android.PublisherKit.PublisherRtcStats
- PublisherTimeout - com.opentok.android.OpentokError.ErrorCode
-
Timeout while attempting to publish.
- PublisherUnableToPublish - com.opentok.android.OpentokError.ErrorCode
- PublisherUnexpectedPeerConnectionDisconnection - com.opentok.android.OpentokError.ErrorCode
- PublisherWebRTCError - com.opentok.android.OpentokError.ErrorCode
-
Subscriber WebRTC failure.
R
- readRenderData(ByteBuffer, int) - Method in class com.opentok.android.BaseAudioDevice.AudioBus
-
Retrieves unrendered audio samples from the session.
- readRenderData(ShortBuffer, int) - Method in class com.opentok.android.BaseAudioDevice.AudioBus
-
Retrieves unrendered audio samples from the session.
- reconnectionListener - Variable in class com.opentok.android.Session
- recycle() - Method in class com.opentok.android.BaseVideoRenderer.Frame
-
Deprecated.If you want to free the memory of a frame you can just set the reference to null and wait the GC to collect it
- Relay - com.opentok.android.Session.Builder.TransportPolicy
- renderer - Variable in class com.opentok.android.PublisherKit
- renderer - Variable in class com.opentok.android.SubscriberKit
- renderer(BaseVideoRenderer) - Method in class com.opentok.android.Publisher.Builder
-
Sets the video renderer to use for the publisher.
- renderer(BaseVideoRenderer) - Method in class com.opentok.android.PublisherKit.Builder
-
Sets the video renderer to use for the publisher.
- renderer(BaseVideoRenderer) - Method in class com.opentok.android.Subscriber.Builder
-
Sets the video renderer to use for the subscriber.
- renderer(BaseVideoRenderer) - Method in class com.opentok.android.SubscriberKit.Builder
-
Sets the video renderer to use for the publisher.
- reportIssue() - Method in class com.opentok.android.Session
-
Report that your app experienced an issue.
- resolution(Publisher.CameraCaptureResolution) - Method in class com.opentok.android.Publisher.Builder
-
Sets the video resolution of the published video.
- RGB - Static variable in class com.opentok.android.BaseVideoCapturer
-
Defines the value for the RGB pixel format used by the
BaseVideoCapturer.CaptureSettings.format
property. - RGBA - Static variable in class com.opentok.android.BaseVideoCapturer
-
Defines the value for the RGBA pixel format used by the
BaseVideoCapturer.CaptureSettings.format
property. - rtcStatsReportListener - Variable in class com.opentok.android.PublisherKit
- rtcStatsReportListener - Variable in class com.opentok.android.SubscriberKit
S
- scalableScreenshare(boolean) - Method in class com.opentok.android.Publisher.Builder
- scalableScreenshare(boolean) - Method in class com.opentok.android.PublisherKit.Builder
-
Whether to allow use of scalable video for a publisher that has the videoType set to PublisherKitVideoTypeScreen (true) or not (false, the default).
- sendSignal(String, String) - Method in class com.opentok.android.Session
-
Sends a signal to all clients in a session.
- sendSignal(String, String, boolean) - Method in class com.opentok.android.Session
-
Sends a signal to all clients in a session.
- sendSignal(String, String, Connection) - Method in class com.opentok.android.Session
-
Sends a signal to a specific client in a session.
- sendSignal(String, String, Connection, boolean) - Method in class com.opentok.android.Session
-
Sends a signal to a specific client in a session.This version of the method includes a
retryAfterReconnect
parameter. - session - Variable in class com.opentok.android.SubscriberKit
- Session - Class in com.opentok.android
-
Represents an OpenTok session in which the client is participating.
- Session(Context, String, String) - Constructor for class com.opentok.android.Session
-
Deprecated.
- Session(Context, String, String, boolean, Session.SessionOptions, Session.Builder.TransportPolicy, Session.Builder.IncludeServers, Session.Builder.IceServer[], URL, boolean, String, boolean) - Constructor for class com.opentok.android.Session
-
Creates a new Session object.
- Session(Context, String, String, Session.SessionOptions) - Constructor for class com.opentok.android.Session
-
Deprecated.
- Session(Context, String, String, Session.SessionOptionsProvider) - Constructor for class com.opentok.android.Session
-
Deprecated.
- Session.ArchiveListener - Interface in com.opentok.android
-
Monitors when an archive recording of the session starts and stops.
- Session.Builder - Class in com.opentok.android
- Session.Builder.IceServer - Class in com.opentok.android
-
This is part of the configurable TURN feature.
- Session.Builder.IncludeServers - Enum in com.opentok.android
-
This is part of the configurable TURN feature.
- Session.Builder.TransportPolicy - Enum in com.opentok.android
-
This is part of the configurable TURN feature.
- Session.Capabilities - Class in com.opentok.android
-
Defines the value returned by the
Session.getCapabilities()
method. - Session.ConfigurableSessionOptions - Class in com.opentok.android
- Session.ConnectionListener - Interface in com.opentok.android
-
Monitors when other clients connect and disconnect to the session.
- Session.MuteListener - Interface in com.opentok.android
-
Monitors when a moderator mutes streams in the session or disables the mute state in the session.
- Session.ReconnectionListener - Interface in com.opentok.android
-
Monitors when an a client tries to automatically reconnect after losing its connection to an OpenTok session.
- Session.SessionListener - Interface in com.opentok.android
-
Monitors state changes in a
Session
object. - Session.SessionOptions - Class in com.opentok.android
-
A base class for defining advanced session options with the
Session.Builder.sessionOptions(Session.SessionOptions sessionOptions)
method. - Session.SessionOptionsProvider - Interface in com.opentok.android
-
Deprecated.
- Session.SignalListener - Interface in com.opentok.android
-
Monitors when a signal is sent in the session.
- Session.StreamCaptionsPropertiesListener - Interface in com.opentok.android
-
Monitors when caption properties of streams in the session change.
- Session.StreamPropertiesListener - Interface in com.opentok.android
-
Monitors when properties of streams in the session change.
- SessionBlockedCountry - com.opentok.android.OpentokError.ErrorCode
-
Unable to connect to the session.
- SessionConnectionLimitExceeded - com.opentok.android.OpentokError.ErrorCode
-
The client tried to connect to a session that has exceeded the limit for simultaneous connections.
- SessionConnectionTimeout - com.opentok.android.OpentokError.ErrorCode
-
The connection timed out while attempting to connect to the session.
- SessionDisconnected - com.opentok.android.OpentokError.ErrorCode
-
Attempting to publish to a disconnected session.
- SessionErrorDomain - com.opentok.android.OpentokError.Domain
-
The error pertains to a
Session
object. - sessionId - Variable in class com.opentok.android.Session
- SessionIllegalState - com.opentok.android.OpentokError.ErrorCode
-
Unable to connect to a session that is already connected.
- SessionInternalError - com.opentok.android.OpentokError.ErrorCode
-
Internal error connecting to the session.
- SessionInvalidSignalType - com.opentok.android.OpentokError.ErrorCode
-
Invalid signal type.
- sessionListener - Variable in class com.opentok.android.Session
- SessionNullOrInvalidParameter - com.opentok.android.OpentokError.ErrorCode
-
You passed an invalid parameter or the Session is null.
- sessionOptions(Session.SessionOptions) - Method in class com.opentok.android.Session.Builder
-
Sets advanced options for the session.
- SessionOptions() - Constructor for class com.opentok.android.Session.SessionOptions
- SessionPublisherNotFound - com.opentok.android.OpentokError.ErrorCode
-
The publisher is unknown to this session.
- SessionSignalDataTooLong - com.opentok.android.OpentokError.ErrorCode
-
Invalid signal -- the data string is too long (maximum length 8196).
- SessionSignalTypeTooLong - com.opentok.android.OpentokError.ErrorCode
-
Invalid signal -- the type string is too long (maximum length 128).
- SessionStateFailed - com.opentok.android.OpentokError.ErrorCode
-
The connection timed out while attempting to get the session's state.
- SessionSubscriberNotFound - com.opentok.android.OpentokError.ErrorCode
-
The subscriber is unknown to this session.
- SessionUnableToForceMute - com.opentok.android.OpentokError.ErrorCode
-
Unable to force mute -- perhaps because the client's capabilities are limited.
- SessionUnexpectedGetSessionInfoResponse - com.opentok.android.OpentokError.ErrorCode
-
Unable to connect to the session.
- set(int, int) - Method in class com.opentok.android.VideoUtils.Size
-
Changes the dimensions of the Size object.
- set(VideoUtils.Size) - Method in class com.opentok.android.VideoUtils.Size
-
Changes the dimensions of the Size object to match the dimensions of an existing Size object.
- setApiUrl(URL) - Method in class com.opentok.android.Session.Builder
-
Deprecated.
- setArchiveListener(Session.ArchiveListener) - Method in class com.opentok.android.Session
-
Sets an
Session.ArchiveListener
object to monitor when an archive recording starts or stops in this session. - setAudioDevice(BaseAudioDevice) - Static method in class com.opentok.android.AudioDeviceManager
-
Sets the audio device to be used.
- setAudioFallbackEnabled(boolean) - Method in class com.opentok.android.PublisherKit
-
Deprecated.
- setAudioLevelListener(PublisherKit.AudioLevelListener) - Method in class com.opentok.android.PublisherKit
-
Binds an
PublisherKit.AudioLevelListener
to this PublisherKit instance to monitor audio level updates. - setAudioLevelListener(SubscriberKit.AudioLevelListener) - Method in class com.opentok.android.SubscriberKit
-
Binds an
SubscriberKit.AudioLevelListener
to this SubscriberKit instance to monitor audio level updates. - setAudioStatsListener(PublisherKit.AudioStatsListener) - Method in class com.opentok.android.PublisherKit
-
Sets up a listener for publisher audio statistics.
- setAudioStatsListener(SubscriberKit.AudioStatsListener) - Method in class com.opentok.android.SubscriberKit
-
Sets up a listener for subscriber audio statistics.
- setAudioTransformers(ArrayList<PublisherKit.AudioTransformer>) - Method in class com.opentok.android.PublisherKit
-
Sets a list of audio transformers to this publisher's audio stream.
- setAudioVolume(double) - Method in class com.opentok.android.SubscriberKit
-
Sets the audio volume, between 0 and 100, of the subscriber.
- setCameraId(int) - Method in class com.opentok.android.Publisher
-
Deprecated.
- setCameraListener(Publisher.CameraListener) - Method in class com.opentok.android.Publisher
-
Sets a
Publisher.CameraListener
object to monitor when the camera used by the publisher changes. - setCaptionsListener(SubscriberKit.CaptionsListener) - Method in class com.opentok.android.SubscriberKit
-
Binds a
SubscriberKit.CaptionsListener
to this SubscriberKit instance to receive captions. - setCapturer(BaseVideoCapturer) - Method in class com.opentok.android.PublisherKit
-
Deprecated.
- setConnectionListener(Session.ConnectionListener) - Method in class com.opentok.android.Session
-
Sets a
Session.ConnectionListener
object to monitor when other clients connect and disconnect from this session. - setCustomIceServers(List<Session.Builder.IceServer>, Session.Builder.IncludeServers) - Method in class com.opentok.android.Session.Builder
-
This is part of the configurable TURN feature.
- setEncryptionSecret(String) - Method in class com.opentok.android.Session
-
Sets the end-to-end encryption secret used by all publishers and subscribers.
- setIceRouting(Session.Builder.TransportPolicy) - Method in class com.opentok.android.Session.Builder
-
This is part of the configurable TURN feature.
- setIpWhitelist(boolean) - Method in class com.opentok.android.Session.Builder
-
Set this to
true
if the allowed IP list feature is enabled for your project. - setMuteListener(PublisherKit.MuteListener) - Method in class com.opentok.android.PublisherKit
-
Sets a
PublisherKit.MuteListener
object to monitor when a moderator forces this publisher to mute audio. - setMuteListener(Session.MuteListener) - Method in class com.opentok.android.Session
-
Sets a
Session.MuteListener
object to monitor when mute forced is sent in this session. - setName(String) - Method in class com.opentok.android.PublisherKit
-
Deprecated.
- setNumChannels(int) - Method in class com.opentok.android.BaseAudioDevice.AudioSettings
-
Sets the number of audio channels.
- setOutputMode(BaseAudioDevice.OutputMode) - Method in class com.opentok.android.BaseAudioDevice
-
Set the audio output mode for the app: video (the default) or voice.
- setPreferredFrameRate(float) - Method in class com.opentok.android.SubscriberKit
-
Sets the preferred frame rate for the subscriber's stream.
- setPreferredResolution(VideoUtils.Size) - Method in class com.opentok.android.SubscriberKit
-
Sets the preferred resolution for the subscriber's stream.
- setProxyUrl(String) - Method in class com.opentok.android.Session.Builder
-
Set this to the URL of the IP proxy server.
- setPublishAudio(boolean) - Method in class com.opentok.android.PublisherKit
-
Toggles publishing of audio on or off, based on the value passed in.
- setPublishCaptions(boolean) - Method in class com.opentok.android.PublisherKit
-
Toggles publishing of captioning on or off, based on the value passed in.
- setPublisherKit(PublisherKit) - Method in class com.opentok.android.BaseVideoCapturer
- setPublisherListener(PublisherKit.PublisherListener) - Method in class com.opentok.android.PublisherKit
-
Binds a
PublisherKit.PublisherListener
to this Publisher instance to monitor state changes. - setPublisherVideoType(PublisherKit.PublisherKitVideoType) - Method in class com.opentok.android.PublisherKit
-
Specifies the type of video for this stream.
- setPublishVideo(boolean) - Method in class com.opentok.android.PublisherKit
-
Toggles publishing of video on or off, based on the value passed in.
- setReconnectionListener(Session.ReconnectionListener) - Method in class com.opentok.android.Session
-
Sets a
Session.ReconnectionListener
object to be notified when the client is attempting to reconnect or reconnected to an OpenTok session. - setRenderer(BaseVideoRenderer) - Method in class com.opentok.android.PublisherKit
-
Deprecated.
- setRenderer(BaseVideoRenderer) - Method in class com.opentok.android.SubscriberKit
-
Deprecated.
- setRtcStatsReportListener(PublisherKit.PublisherRtcStatsReportListener) - Method in class com.opentok.android.PublisherKit
-
Sets the RTC stats report listener the subscriber.
- setRtcStatsReportListener(SubscriberKit.SubscriberRtcStatsReportListener) - Method in class com.opentok.android.SubscriberKit
-
Sets the RTC stats report listener for the subscriber.
- setSampleRate(int) - Method in class com.opentok.android.BaseAudioDevice.AudioSettings
-
Sets the sample rate (in samples per second).
- setSessionListener(Session.SessionListener) - Method in class com.opentok.android.Session
-
Sets a
Session.SessionListener
object to monitor state changes for this Session object. - setSignalListener(Session.SignalListener) - Method in class com.opentok.android.Session
-
Sets a
Session.SignalListener
object to monitor when signals are sent in this session. - setSinglePeerConnection(boolean) - Method in class com.opentok.android.Session.Builder
-
Single Peer Connection (SPC) is a feature that encapsulates all subscriber connections to a single peer connection.
- setStreamCaptionsPropertiesListener(Session.StreamCaptionsPropertiesListener) - Method in class com.opentok.android.Session
-
Sets a
Session.StreamCaptionsPropertiesListener
object to monitor properties of stream captions property. - setStreamListener(SubscriberKit.StreamListener) - Method in class com.opentok.android.SubscriberKit
-
Sets up a listener for events related to the subscriber's stream being interrupted and resuming.
- setStreamPropertiesListener(Session.StreamPropertiesListener) - Method in class com.opentok.android.Session
-
Sets a
Session.StreamPropertiesListener
object to monitor properties of streams in this session change. - setStyle(String, String) - Method in class com.opentok.android.BaseVideoRenderer
-
Set a style for this video renderer.
- setStyle(String, String) - Method in class com.opentok.android.PublisherKit
-
Sets a style for the video renderer used by this publisher.
- setStyle(String, String) - Method in class com.opentok.android.SubscriberKit
-
Set a style used by this subscriber.
- setSubscriberListener(SubscriberKit.SubscriberListener) - Method in class com.opentok.android.SubscriberKit
-
Sets a
SubscriberKit.SubscriberListener
object to monitor state changes. - setSubscribeToAudio(boolean) - Method in class com.opentok.android.SubscriberKit
-
Whether to subscribe to the stream's audio (
true
) or not (false
). - setSubscribeToCaptions(boolean) - Method in class com.opentok.android.SubscriberKit
-
Whether to subscribe to the stream's captions (
true
) or not (false
).. - setSubscribeToVideo(boolean) - Method in class com.opentok.android.SubscriberKit
-
Whether to subscribe to the stream's video (
true
) or not (false
). - setVideoContentHint(BaseVideoCapturer.VideoContentHint) - Method in class com.opentok.android.BaseVideoCapturer
-
Sets the video content hint.
- setVideoListener(PublisherKit.VideoListener) - Method in class com.opentok.android.PublisherKit
-
Sets a
PublisherKit.VideoListener
object to monitor when the publisher starts and stops sending video. - setVideoListener(SubscriberKit.VideoListener) - Method in class com.opentok.android.SubscriberKit
-
Sets a
SubscriberKit.VideoListener
object to monitor when the subscriber starts and stops receiving video. - setVideoStatsListener(PublisherKit.VideoStatsListener) - Method in class com.opentok.android.PublisherKit
-
Sets up a listener for publisher video statistics.
- setVideoStatsListener(SubscriberKit.VideoStatsListener) - Method in class com.opentok.android.SubscriberKit
-
Sets up a listener for subscriber video statistics.
- setVideoTransformers(ArrayList<PublisherKit.VideoTransformer>) - Method in class com.opentok.android.PublisherKit
-
Sets a list of video transformers to this publisher's video stream.
- signalListener - Variable in class com.opentok.android.Session
- Size() - Constructor for class com.opentok.android.VideoUtils.Size
- Size(int, int) - Constructor for class com.opentok.android.VideoUtils.Size
-
Constructs a Size object, to be used when setting the preferred resolution using the
SubscriberKit.setPreferredResolution(VideoUtils.Size preferredResolution)
method. - Size(VideoUtils.Size) - Constructor for class com.opentok.android.VideoUtils.Size
-
Constructs a new Size object, based on the dimensions of an existing Size object.
- SpeakerPhone - com.opentok.android.BaseAudioDevice.OutputMode
-
Defines the speakerphone audio output mode setting for the
BaseAudioDevice.setOutputMode(OutputMode mode)
method. - startCapture() - Method in class com.opentok.android.BaseVideoCapturer
-
Starts capturing video.
- startCapturer() - Method in class com.opentok.android.BaseAudioDevice
-
Requests that the device start capturing audio samples.
- startPreview() - Method in class com.opentok.android.Publisher
-
Deprecated.
- startRenderer() - Method in class com.opentok.android.BaseAudioDevice
-
Requests that the device start rendering audio.
- startTime - Variable in class com.opentok.android.PublisherKit.PublisherAudioStats
-
The timestamp, in milliseconds since the Unix epoch, from which the cumulative totals started accumulating.
- startTime - Variable in class com.opentok.android.PublisherKit.PublisherVideoStats
-
The timestamp, in milliseconds since the Unix epoch, from which the cumulative totals started accumulating.
- stopCapture() - Method in class com.opentok.android.BaseVideoCapturer
-
Stops capturing video.
- stopCapturer() - Method in class com.opentok.android.BaseAudioDevice
-
Requests that the device stop sampling audio.
- stopRenderer() - Method in class com.opentok.android.BaseAudioDevice
-
Requests that the device stop rendering audio.
- stream - Variable in class com.opentok.android.SubscriberKit
- Stream - Class in com.opentok.android
-
Represents an audio-video stream in an OpenTok session.
- Stream.StreamVideoType - Enum in com.opentok.android
-
Defines values for the
Stream.getStreamVideoType()
method. - streamCaptionsPropertiesListener - Variable in class com.opentok.android.Session
- streamListener - Variable in class com.opentok.android.SubscriberKit
- streamPropertiesListener - Variable in class com.opentok.android.Session
- StreamVideoTypeCamera - com.opentok.android.Stream.StreamVideoType
-
Defines the camera video mode setting for the
Stream.getStreamVideoType()
method. - StreamVideoTypeCustom - com.opentok.android.Stream.StreamVideoType
-
Defines the custom video mode setting for the
Stream.getStreamVideoType()
method. - StreamVideoTypeScreen - com.opentok.android.Stream.StreamVideoType
-
Defines the screen video mode setting for the
Stream.getStreamVideoType()
method. - STYLE_VIDEO_FILL - Static variable in class com.opentok.android.BaseVideoRenderer
-
A value for the
STYLE_VIDEO_SCALE
style, specfying that the video scales to fill the entire area of the renderer, with cropping as needed). - STYLE_VIDEO_FIT - Static variable in class com.opentok.android.BaseVideoRenderer
-
A value for the
STYLE_VIDEO_SCALE
style, specfying that the video shrinks, as needed, so that the entire video is visible with pillarboxing. - STYLE_VIDEO_SCALE - Static variable in class com.opentok.android.BaseVideoRenderer
-
A value for the
key
parameter of theBaseVideoRenderer.setStyle(String key, String value)
,SubscriberKit.setStyle(String key, String value)
, andPublisherKit.setStyle(String key, String value)
methods, used to determine the scaling of the video. - subscribe(SubscriberKit) - Method in class com.opentok.android.Session
-
Start receiving and rendering audio-video stream data for the specified subscriber.
- Subscriber - Class in com.opentok.android
-
Used to consume an audio-video stream in the OpenTok session.
- Subscriber(Context, Stream) - Constructor for class com.opentok.android.Subscriber
-
Deprecated.
- Subscriber(Context, Stream, BaseVideoRenderer) - Constructor for class com.opentok.android.Subscriber
-
Creates a new Subscriber object for a given stream.
- Subscriber.Builder - Class in com.opentok.android
-
Used to build a
Subscriber
object. - subscriberAudioFallbackEnabled(boolean) - Method in class com.opentok.android.Publisher.Builder
- subscriberAudioFallbackEnabled(boolean) - Method in class com.opentok.android.PublisherKit.Builder
-
Whether the stream will use the subscriber audio-fallback feature (
true
) or not (false
), for subscribers to the published stream. - SubscriberErrorDomain - com.opentok.android.OpentokError.Domain
-
The error pertains to a
Subscriber
object. - subscriberId - Variable in class com.opentok.android.PublisherKit.PublisherAudioStats
-
The subscriber ID of the client subscribing to the stream (in a relayed session).
- subscriberId - Variable in class com.opentok.android.PublisherKit.PublisherVideoStats
-
The subscriber ID of the client subscribing to the stream (in a relayed session).
- SubscriberInternalError - com.opentok.android.OpentokError.ErrorCode
-
Internal error when subscribing.
- SubscriberKit - Class in com.opentok.android
-
A SubscriberKit (subscriber) object renders media data bound to a Stream The SubscriberKit class lets you set a custom video renderer for the video stream.
- SubscriberKit(Context, Stream) - Constructor for class com.opentok.android.SubscriberKit
-
Deprecated.
- SubscriberKit(Context, Stream, BaseVideoRenderer) - Constructor for class com.opentok.android.SubscriberKit
-
Creates a new SubscriberKit object for a given stream.
- SubscriberKit.AudioLevelListener - Interface in com.opentok.android
-
Monitors changes in the audio level of the subscriber.
- SubscriberKit.AudioStatsListener - Interface in com.opentok.android
-
Defines the listener object for getting subscriber audio statistcs.
- SubscriberKit.Builder - Class in com.opentok.android
-
Used to build a
SubscriberKit
object. - SubscriberKit.CaptionsListener - Interface in com.opentok.android
-
A listener for updated caption text.
- SubscriberKit.StreamListener - Interface in com.opentok.android
-
Monitors when the subscriber's stream is interrupted and resumes.
- SubscriberKit.SubscriberAudioStats - Class in com.opentok.android
-
Defines audio statistics for a subscriber.
- SubscriberKit.SubscriberListener - Interface in com.opentok.android
-
Monitors state changes of a
SubscriberKit
instance. - SubscriberKit.SubscriberRtcStatsReportListener - Interface in com.opentok.android
-
Defines the listener object for getting subscriber RTC stats reports.
- SubscriberKit.SubscriberVideoStats - Class in com.opentok.android
-
Defines video statistics for a subscriber.
- SubscriberKit.VideoListener - Interface in com.opentok.android
-
Monitors when the subscriber starts and stops receiving video data.
- SubscriberKit.VideoStatsListener - Interface in com.opentok.android
-
Defines the listener object for getting subscriber video statistcs.
- subscriberListener - Variable in class com.opentok.android.SubscriberKit
- SubscriberServerCannotFindStream - com.opentok.android.OpentokError.ErrorCode
-
The subscriber failed due to the stream being missing.
- SubscriberStreamLimitExceeded - com.opentok.android.OpentokError.ErrorCode
-
The client tried to subscribe to a stream in a session that has exceeded the limit for simultaneous streams.
- SubscriberWebRTCError - com.opentok.android.OpentokError.ErrorCode
-
Subscriber WebRTC failure.
- SupportedCodecs() - Constructor for class com.opentok.android.MediaUtils.SupportedCodecs
- swapCamera() - Method in class com.opentok.android.Publisher
-
Deprecated.
- swapCamera(int) - Method in interface com.opentok.android.BaseVideoCapturer.CaptureSwitch
-
Defines the behavior of the deprecated
Publisher.swapCamera()
method for a Publisher object that uses the custom video capturer.
T
- TEXT - com.opentok.android.BaseVideoCapturer.VideoContentHint
-
The track should be treated as if video details are extra important, and that significant sharp edges and areas of consistent color can occur frequently.
- timeStamp - Variable in class com.opentok.android.PublisherKit.PublisherAudioStats
-
The timestamp, in milliseconds since the Unix epoch, for when these stats were gathered.
- timeStamp - Variable in class com.opentok.android.PublisherKit.PublisherVideoStats
-
The timestamp, in milliseconds since the Unix epoch, for when these stats were gathered.
- timeStamp - Variable in class com.opentok.android.SubscriberKit.SubscriberAudioStats
-
The timestamp, in milliseconds since the Unix epoch, for when these stats were gathered.
- timeStamp - Variable in class com.opentok.android.SubscriberKit.SubscriberVideoStats
-
The timestamp, in milliseconds since the Unix epoch, for when these stats were gathered.
- toString() - Method in class com.opentok.android.Session.Builder.IceServer
- toString() - Method in class com.opentok.android.Session.Capabilities
- toString() - Method in class com.opentok.android.Stream
U
- UnknownError - com.opentok.android.OpentokError.ErrorCode
- UnknownPublisherInstance - com.opentok.android.OpentokError.ErrorCode
-
Cannot unpublish: An unknown Publisher instance was passed into the Session.unpublish() method.
- UnknownSubscriberInstance - com.opentok.android.OpentokError.ErrorCode
-
Cannot unsubscribe: An unknown Subscriber instance was passed into the Session.unsubscribe() method.
- unpublish(PublisherKit) - Method in class com.opentok.android.Session
-
Disconnects the Publisher from the session.
- unsubscribe(SubscriberKit) - Method in class com.opentok.android.Session
-
Stops subscribing (receiving a stream) to a specified subscriber in the session.
- update(Observable, Object) - Method in class com.opentok.android.PublisherKit
-
This method is called whenever the observed object is changed.
- update(Observable, Object) - Method in class com.opentok.android.SubscriberKit
-
This method is called whenever the observed object is changed.
- url - Variable in class com.opentok.android.Session.Builder.IceServer
- user - Variable in class com.opentok.android.Session.Builder.IceServer
- useTextureViews() - Method in class com.opentok.android.Session.SessionOptions
-
Return
true
if you want publishers and subscriber to use TextureViews instead of GLSurfaceViews. - uvStride - Variable in class com.opentok.android.BaseVideoRenderer.Frame
- UYVY - Static variable in class com.opentok.android.BaseVideoCapturer
-
Defines the value for the UYVY pixel format used by the
BaseVideoCapturer.CaptureSettings.format
property.
V
- valueOf(int) - Static method in enum com.opentok.android.BaseVideoCapturer.VideoContentHint
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.opentok.android.BaseAudioDevice.BluetoothState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.opentok.android.BaseAudioDevice.OutputMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.opentok.android.BaseVideoCapturer.VideoContentHint
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.opentok.android.MediaUtils.VideoCodecType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.opentok.android.OpentokError.Domain
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.opentok.android.OpentokError.ErrorCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.opentok.android.Publisher.CameraCaptureFrameRate
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.opentok.android.Publisher.CameraCaptureResolution
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.opentok.android.PublisherKit.PublisherKitVideoType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.opentok.android.Session.Builder.IncludeServers
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.opentok.android.Session.Builder.TransportPolicy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.opentok.android.Stream.StreamVideoType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.opentok.android.BaseAudioDevice.BluetoothState
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.opentok.android.BaseAudioDevice.OutputMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.opentok.android.BaseVideoCapturer.VideoContentHint
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.opentok.android.MediaUtils.VideoCodecType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.opentok.android.OpentokError.Domain
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.opentok.android.OpentokError.ErrorCode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.opentok.android.Publisher.CameraCaptureFrameRate
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.opentok.android.Publisher.CameraCaptureResolution
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.opentok.android.PublisherKit.PublisherKitVideoType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.opentok.android.Session.Builder.IncludeServers
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.opentok.android.Session.Builder.TransportPolicy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.opentok.android.Stream.StreamVideoType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VIDEO_CODEC_H264 - com.opentok.android.MediaUtils.VideoCodecType
-
H.264.
- VIDEO_CODEC_VP8 - com.opentok.android.MediaUtils.VideoCodecType
-
VP8.
- VIDEO_CODEC_VP9 - com.opentok.android.MediaUtils.VideoCodecType
-
VP9.
- VIDEO_REASON_CODEC_NOT_SUPPORTED - Static variable in class com.opentok.android.SubscriberKit
-
The video event was caused when video in the the subscriber stream was disabled because the stream uses a video codec (such as H.264) not supported on the device.
- VIDEO_REASON_PUBLISH_VIDEO - Static variable in class com.opentok.android.SubscriberKit
-
The video event was caused by the stream's publisher starting or stopping the video stream.
- VIDEO_REASON_QUALITY - Static variable in class com.opentok.android.SubscriberKit
-
The video event was caused by a change to the video stream quality.
- VIDEO_REASON_SUBSCRIBE_TO_VIDEO - Static variable in class com.opentok.android.SubscriberKit
-
The video event was caused by a call to the
SubscriberKit.setSubscribeToVideo(boolean subscribeToVideo)
method. - videoBytesReceived - Variable in class com.opentok.android.SubscriberKit.SubscriberVideoStats
-
The total number of video bytes received by the subscriber.
- videoBytesSent - Variable in class com.opentok.android.PublisherKit.PublisherVideoStats
-
The total number of video bytes bytes sent to the subscriber (or to the OpenTok Media Router).
- VideoCaptureFailed - com.opentok.android.OpentokError.ErrorCode
-
There was an error in the video capturer.
- videoDecoderCodecs - Variable in class com.opentok.android.MediaUtils.SupportedCodecs
-
An array of
MediaUtils.VideoCodecType
values, defining the video codecs for decoding that are supported on the device. - videoEncoderCodecs - Variable in class com.opentok.android.MediaUtils.SupportedCodecs
-
An array of
MediaUtils.VideoCodecType
values, defining the video codecs for encoding that are supported on the device. - videoListener - Variable in class com.opentok.android.PublisherKit
- videoListener - Variable in class com.opentok.android.SubscriberKit
- videoPacketsLost - Variable in class com.opentok.android.PublisherKit.PublisherVideoStats
-
The total number of video packets packets that did not reach the subscriber (or the OpenTok Media Router).
- videoPacketsLost - Variable in class com.opentok.android.SubscriberKit.SubscriberVideoStats
-
The total number of video packets lost by the subscriber.
- videoPacketsReceived - Variable in class com.opentok.android.SubscriberKit.SubscriberVideoStats
-
The total number of video packets received by the subscriber.
- videoPacketsSent - Variable in class com.opentok.android.PublisherKit.PublisherVideoStats
-
The total number of video packets sent sent to the subscriber (or to the OpenTok Media Router).
- VideoRenderFailed - com.opentok.android.OpentokError.ErrorCode
-
There was an error in the video renderer.
- videoStatsListener - Variable in class com.opentok.android.PublisherKit
- videoStatsListener - Variable in class com.opentok.android.SubscriberKit
- videoTrack(boolean) - Method in class com.opentok.android.Publisher.Builder
- videoTrack(boolean) - Method in class com.opentok.android.PublisherKit.Builder
-
Sets whether to include an video track in the published stream (
true
, the default) or not (false
). - VideoTransformer(String, PublisherKit.CustomVideoTransformer) - Constructor for class com.opentok.android.PublisherKit.VideoTransformer
-
Creates an instance of a custom video transformer.
- VideoTransformer(String, String) - Constructor for class com.opentok.android.PublisherKit.VideoTransformer
-
Creates an instance of a Vonage video transformer.
- VideoUtils - Class in com.opentok.android
-
Includes a VideoUtils class, used when setting the preferred resolution using the
SubscriberKit.setPreferredResolution(VideoUtils.Size preferredResolution)
method. - VideoUtils() - Constructor for class com.opentok.android.VideoUtils
- VideoUtils.Size - Class in com.opentok.android
-
Defines a video resolution to be used when setting the preferred resolution using the
SubscriberKit.setPreferredResolution(VideoUtils.Size preferredResolution)
method.
W
- width - Variable in class com.opentok.android.BaseVideoCapturer.CaptureSettings
-
The width of the video, in pixels.
- width - Variable in class com.opentok.android.BaseVideoRenderer.Frame
- width - Variable in class com.opentok.android.VideoUtils.Size
-
The width, in pixels.
- writeCaptureData(ByteBuffer, int) - Method in class com.opentok.android.BaseAudioDevice.AudioBus
-
Passes audio data to transmit to a session.
- writeCaptureData(ShortBuffer, int) - Method in class com.opentok.android.BaseAudioDevice.AudioBus
-
Passes audio data to transmit to a session.
Y
- yStride - Variable in class com.opentok.android.BaseVideoRenderer.Frame
- YUV420P - Static variable in class com.opentok.android.BaseVideoCapturer
-
Defines the value for the YUV420P pixel format used by the
BaseVideoCapturer.CaptureSettings.format
property. - YUY2 - Static variable in class com.opentok.android.BaseVideoCapturer
-
Defines the value for the YUY2 pixel format used by the
BaseVideoCapturer.CaptureSettings.format
property.
All Classes All Packages