Documentation

Application

Interfaces, Classes, Traits and Enums

ArchiveException
The interface used by all exceptions resulting from calls to the archiving API.
BroadcastException
The interface used by all exceptions resulting from calls to the broadcast API.
Exception
The interface used by all exceptions in the OpenTok PHP API.
ForceDisconnectException
The interface used by all exceptions resulting from calls to the signal API.
SignalException
The interface used by all exceptions resulting from calls to the signal API.
Archive
Represents an archive of an OpenTok session.
ArchiveList
A class for accessing an array of Archive objects.
ArchiveMode
Defines values for the archiveMode parameter of the OpenTok->createSession method and the return value for the Session->getArchiveMode() method.
Broadcast
Represents a broadcast of an OpenTok session.
ArchiveAuthenticationException
Defines the exception thrown when you use an invalid API or secret and call an archiving method.
ArchiveDomainException
Defines an exception thrown when a call to an archiving method results in an error response from the server.
ArchiveUnexpectedValueException
Defines an exception thrown when a call to an archiving method results in an error due to an unexpected value.
AuthenticationException
Defines the exception thrown when you use an invalid API or secret.
BroadcastAuthenticationException
Defines the exception thrown when you use an invalid API or secret and call a broadcast method.
BroadcastDomainException
Defines an exception thrown when a call to a broadcast method results in an error response from the server.
BroadcastUnexpectedValueException
Defines an exception thrown when a call to a broadcast method results in an error due to an unexpected value.
DomainException
Defines an exception thrown when an API call results in an error response from the server.
ForceDisconnectAuthenticationException
Defines the exception thrown when you use an invalid API or secret and call the force disconnect method.
ForceDisconnectConnectionException
Defines an exception thrown when a call to a force disconnect method results in an error response from the server.
ForceDisconnectUnexpectedValueException
Defines an exception thrown when a call to the force disconnect method results in an error due to an unexpected value.
InvalidArgumentException
Defines an exception thrown when you pass an invalid argument into a method.
SignalAuthenticationException
Defines the exception thrown when you use an invalid API or secret and call a signal method.
SignalConnectionException
Defines an exception thrown when a call to a signal method results in an error response from the server.
SignalNetworkConnectionException
Defines an exception thrown when a call to a signal method results in no response from the server
SignalUnexpectedValueException
Defines an exception thrown when a call to a signal method results in an error due to an unexpected value.
UnexpectedValueException
Defines an exception thrown in result of an unexpected value.
Layout
Defines the object passed in as the $layout parameter of the OpenTok->setArchiveLayout() and OpenTok->updateBroadcastLayout() methods.
MediaMode
Defines values for the mediaMode parameter of the \OpenTok\OpenTok->createSession() method.
OpenTok
Contains methods for creating OpenTok sessions, generating tokens, and working with archives.
OutputMode
Defines values for the outputMode option of the \OpenTok\OpenTok->startArchive() method and for the outputMode property of the Archive class.
Render
Represents an Experience Composer render of an OpenTok session.
Role
Defines values for the role parameter of the \OpenTok\OpenTok->generateToken() method.
Session
Represents an OpenTok session.
SipCall
Represents data from a SIP Call
Stream
Represents a stream in an OpenTok session.
StreamList
An object, returned by the <a href="OpenTok.OpenTok.html#method_listStreams">OpenTok.listStreams()</a> method, representing a list of streams in an OpenTok session.
StreamMode
Defines streamMode values that can be used when either starting an Archive or a Broadcast

Search results