Preparing search index...
The search index is not available
@zoom/rivet
@zoom/rivet
Video SDK
Module Video SDK
Enumerations
LogLevel
StatusCode
Classes
AwsLambdaReceiver
ConsoleLogger
HttpReceiver
VideoSdkClient
VideoSdkEndpoints
VideoSdkEventProcessor
Interfaces
BaseResponse
Event
HttpReceiverOptions
Logger
Receiver
ReceiverInitOptions
StateStore
TokenStore
WebEndpointOptions
Type Aliases
AllPropsOptional
ByosStorageAddStorageLocationRequestBody
ByosStorageAddStorageLocationResponse
ByosStorageChangeStorageLocationDetailPathParams
ByosStorageChangeStorageLocationDetailRequestBody
ByosStorageDeleteStorageLocationDetailPathParams
ByosStorageListStorageLocationResponse
ByosStorageStorageLocationDetailPathParams
ByosStorageStorageLocationDetailResponse
ByosStorageUpdateBringYourOwnStorageSettingsRequestBody
ClientConstructorOptions
CloudRecordingDeleteSessionsRecordingFilePathParams
CloudRecordingDeleteSessionsRecordingFileQueryParams
CloudRecordingDeleteSessionsRecordingsPathParams
CloudRecordingDeleteSessionsRecordingsQueryParams
CloudRecordingListRecordingsOfAccountQueryParams
CloudRecordingListRecordingsOfAccountResponse
CloudRecordingListSessionsRecordingsPathParams
CloudRecordingListSessionsRecordingsQueryParams
CloudRecordingListSessionsRecordingsResponse
CloudRecordingRecoverSessionsRecordingsPathParams
CloudRecordingRecoverSessionsRecordingsRequestBody
CloudRecordingRecoverSingleRecordingPathParams
CloudRecordingRecoverSingleRecordingRequestBody
CommonClientOptions
Constructor
Errors
ExactlyOneOf
GenericEventManager
HttpMethod
MaybeArray
MaybePromise
MergedDefaultOptions
NoParams
RequestMimeType
RequiredKeys
SessionAlertEvent
SessionEndedEvent
SessionLiveStreamingStartedEvent
SessionLiveStreamingStoppedEvent
SessionRecordingCompletedEvent
SessionRecordingDeletedEvent
SessionRecordingPausedEvent
SessionRecordingRecoveredEvent
SessionRecordingResumedEvent
SessionRecordingStartedEvent
SessionRecordingStoppedEvent
SessionRecordingTranscriptCompletedEvent
SessionRecordingTranscriptFailedEvent
SessionRecordingTrashedEvent
SessionsCreateSessionRequestBody
SessionsCreateSessionResponse
SessionsDeleteSessionPathParams
SessionsGetSessionDetailsPathParams
SessionsGetSessionDetailsQueryParams
SessionsGetSessionDetailsResponse
SessionsGetSessionLiveStreamDetailsPathParams
SessionsGetSessionLiveStreamDetailsResponse
SessionsGetSessionUserQoSPathParams
SessionsGetSessionUserQoSQueryParams
SessionsGetSessionUserQoSResponse
SessionsGetSharingRecordingDetailsPathParams
SessionsGetSharingRecordingDetailsQueryParams
SessionsGetSharingRecordingDetailsResponse
SessionSharingEndedEvent
SessionSharingStartedEvent
SessionsListSessionsQueryParams
SessionsListSessionsResponse
SessionsListSessionUsersPathParams
SessionsListSessionUsersQoSPathParams
SessionsListSessionUsersQoSQueryParams
SessionsListSessionUsersQoSResponse
SessionsListSessionUsersQueryParams
SessionsListSessionUsersResponse
SessionStartedEvent
SessionsUpdateSessionLiveStreamPathParams
SessionsUpdateSessionLiveStreamRequestBody
SessionsUpdateSessionLivestreamStatusPathParams
SessionsUpdateSessionLivestreamStatusRequestBody
SessionsUpdateSessionStatusPathParams
SessionsUpdateSessionStatusRequestBody
SessionsUseInSessionEventsControlsPathParams
SessionsUseInSessionEventsControlsRequestBody
SessionUserJoinedEvent
SessionUserLeftEvent
SessionUserPhoneCalloutAcceptedEvent
SessionUserPhoneCalloutMissedEvent
SessionUserPhoneCalloutRejectedEvent
SessionUserPhoneCalloutRingingEvent
SessionUserRoomSystemCalloutAcceptedEvent
SessionUserRoomSystemCalloutFailedEvent
SessionUserRoomSystemCalloutMissedEvent
SessionUserRoomSystemCalloutRejectedEvent
SessionUserRoomSystemCalloutRingingEvent
StringIndexed
VideoSdkOptions
VideoSDKReportsGetCloudRecordingUsageReportQueryParams
VideoSDKReportsGetCloudRecordingUsageReportResponse
VideoSDKReportsGetDailyUsageReportQueryParams
VideoSDKReportsGetDailyUsageReportResponse
VideoSDKReportsGetOperationLogsReportQueryParams
VideoSDKReportsGetOperationLogsReportResponse
VideoSDKReportsGetTelephoneReportQueryParams
VideoSDKReportsGetTelephoneReportResponse
WideInstallerOptions
ZoomResponseError
Variables
ApiResponseError
AwsReceiverRequestError
ClientCredentialsRawResponseError
CommonHttpRequestError
DEFAULT_HTTP_RECEIVER_PORT
HTTPReceiverConstructionError
HTTPReceiverPortNotNumberError
HTTPReceiverRequestError
OAuthInstallerNotInitializedError
OAuthStateVerificationFailedError
OAuthTokenDoesNotExistError
OAuthTokenFetchFailedError
OAuthTokenRawResponseError
OAuthTokenRefreshFailedError
ProductClientConstructionError
ReceiverInconsistentStateError
ReceiverOAuthFlowError
S2SRawResponseError
Functions
isCoreError
isStateStore
mergeDefaultOptions
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Enumerations
Log
Level
Status
Code
Classes
Aws
Lambda
Receiver
Console
Logger
Http
Receiver
Video
Sdk
Client
Video
Sdk
Endpoints
Video
Sdk
Event
Processor
Interfaces
Base
Response
Event
Http
Receiver
Options
Logger
Receiver
Receiver
Init
Options
State
Store
Token
Store
Web
Endpoint
Options
Type Aliases
All
Props
Optional
Byos
Storage
Add
Storage
Location
Request
Body
Byos
Storage
Add
Storage
Location
Response
Byos
Storage
Change
Storage
Location
Detail
Path
Params
Byos
Storage
Change
Storage
Location
Detail
Request
Body
Byos
Storage
Delete
Storage
Location
Detail
Path
Params
Byos
Storage
List
Storage
Location
Response
Byos
Storage
Storage
Location
Detail
Path
Params
Byos
Storage
Storage
Location
Detail
Response
Byos
Storage
Update
Bring
Your
Own
Storage
Settings
Request
Body
Client
Constructor
Options
Cloud
Recording
Delete
Sessions
Recording
File
Path
Params
Cloud
Recording
Delete
Sessions
Recording
File
Query
Params
Cloud
Recording
Delete
Sessions
Recordings
Path
Params
Cloud
Recording
Delete
Sessions
Recordings
Query
Params
Cloud
Recording
List
Recordings
Of
Account
Query
Params
Cloud
Recording
List
Recordings
Of
Account
Response
Cloud
Recording
List
Sessions
Recordings
Path
Params
Cloud
Recording
List
Sessions
Recordings
Query
Params
Cloud
Recording
List
Sessions
Recordings
Response
Cloud
Recording
Recover
Sessions
Recordings
Path
Params
Cloud
Recording
Recover
Sessions
Recordings
Request
Body
Cloud
Recording
Recover
Single
Recording
Path
Params
Cloud
Recording
Recover
Single
Recording
Request
Body
Common
Client
Options
Constructor
Errors
Exactly
One
Of
Generic
Event
Manager
Http
Method
Maybe
Array
Maybe
Promise
Merged
Default
Options
No
Params
Request
Mime
Type
Required
Keys
Session
Alert
Event
Session
Ended
Event
Session
Live
Streaming
Started
Event
Session
Live
Streaming
Stopped
Event
Session
Recording
Completed
Event
Session
Recording
Deleted
Event
Session
Recording
Paused
Event
Session
Recording
Recovered
Event
Session
Recording
Resumed
Event
Session
Recording
Started
Event
Session
Recording
Stopped
Event
Session
Recording
Transcript
Completed
Event
Session
Recording
Transcript
Failed
Event
Session
Recording
Trashed
Event
Sessions
Create
Session
Request
Body
Sessions
Create
Session
Response
Sessions
Delete
Session
Path
Params
Sessions
Get
Session
Details
Path
Params
Sessions
Get
Session
Details
Query
Params
Sessions
Get
Session
Details
Response
Sessions
Get
Session
Live
Stream
Details
Path
Params
Sessions
Get
Session
Live
Stream
Details
Response
Sessions
Get
Session
User
QoSPath
Params
Sessions
Get
Session
User
QoSQuery
Params
Sessions
Get
Session
User
QoSResponse
Sessions
Get
Sharing
Recording
Details
Path
Params
Sessions
Get
Sharing
Recording
Details
Query
Params
Sessions
Get
Sharing
Recording
Details
Response
Session
Sharing
Ended
Event
Session
Sharing
Started
Event
Sessions
List
Sessions
Query
Params
Sessions
List
Sessions
Response
Sessions
List
Session
Users
Path
Params
Sessions
List
Session
Users
QoSPath
Params
Sessions
List
Session
Users
QoSQuery
Params
Sessions
List
Session
Users
QoSResponse
Sessions
List
Session
Users
Query
Params
Sessions
List
Session
Users
Response
Session
Started
Event
Sessions
Update
Session
Live
Stream
Path
Params
Sessions
Update
Session
Live
Stream
Request
Body
Sessions
Update
Session
Livestream
Status
Path
Params
Sessions
Update
Session
Livestream
Status
Request
Body
Sessions
Update
Session
Status
Path
Params
Sessions
Update
Session
Status
Request
Body
Sessions
Use
In
Session
Events
Controls
Path
Params
Sessions
Use
In
Session
Events
Controls
Request
Body
Session
User
Joined
Event
Session
User
Left
Event
Session
User
Phone
Callout
Accepted
Event
Session
User
Phone
Callout
Missed
Event
Session
User
Phone
Callout
Rejected
Event
Session
User
Phone
Callout
Ringing
Event
Session
User
Room
System
Callout
Accepted
Event
Session
User
Room
System
Callout
Failed
Event
Session
User
Room
System
Callout
Missed
Event
Session
User
Room
System
Callout
Rejected
Event
Session
User
Room
System
Callout
Ringing
Event
String
Indexed
Video
Sdk
Options
VideoSDKReports
Get
Cloud
Recording
Usage
Report
Query
Params
VideoSDKReports
Get
Cloud
Recording
Usage
Report
Response
VideoSDKReports
Get
Daily
Usage
Report
Query
Params
VideoSDKReports
Get
Daily
Usage
Report
Response
VideoSDKReports
Get
Operation
Logs
Report
Query
Params
VideoSDKReports
Get
Operation
Logs
Report
Response
VideoSDKReports
Get
Telephone
Report
Query
Params
VideoSDKReports
Get
Telephone
Report
Response
Wide
Installer
Options
Zoom
Response
Error
Variables
Api
Response
Error
Aws
Receiver
Request
Error
Client
Credentials
Raw
Response
Error
Common
Http
Request
Error
DEFAULT_
HTTP_
RECEIVER_
PORT
HTTPReceiver
Construction
Error
HTTPReceiver
Port
Not
Number
Error
HTTPReceiver
Request
Error
OAuth
Installer
Not
Initialized
Error
OAuth
State
Verification
Failed
Error
OAuth
Token
Does
Not
Exist
Error
OAuth
Token
Fetch
Failed
Error
OAuth
Token
Raw
Response
Error
OAuth
Token
Refresh
Failed
Error
Product
Client
Construction
Error
Receiver
Inconsistent
State
Error
ReceiverOAuth
Flow
Error
S2SRaw
Response
Error
Functions
is
Core
Error
is
State
Store
merge
Default
Options
@zoom/rivet
Loading...