Static
acceptStatic
addStatic
addUploads an image that can be used and overlay later. A blob is used.
The id of the event.
Image data as a blob
Optional
data: objectAny additional data to be sent in the request.
Optional
params: Record<string, any>promise
Static
addUploads an image that can be used and overlay later. A File object is used.
The id of the event.
The image as a file.
Optional
data: objectAny additional data to be sent in the request.
promise
Static
addRTMPSourceAdd an RTMP source to multicast a stream too.
The id of the event.
Optional
data: objectThe data to be passed when adding an RTMP source.
Optional
params: Record<string, any>promise
Static
addAdd a Twitch Stream to the current event. The user must have authenticatd with Twitch.
The id of the event.
Optional
data: objectThe data to be passed when adding an RTMP source.
Optional
params: Record<string, any>promise
Static
addAdd a Youtube Stream to the current event. The user must have authenticatd with Google.
The id of the event.
Optional
data: objectThe data to be passed when adding an RTMP source.
Optional
params: Record<string, any>promise
Static
createStatic
deleteStatic
disableStatic
disableStatic
disableDisable a widget for the current event.
The id of the event to update.
The id of the widget to disable.
Optional
params: Record<string, any>promise
Static
enableEnable Broadcast Mode. Broadcast mode is when the live stream is broadcasted from the game play through a protocol such as screen sharing.
The id of the event.
Optional
data: objectOptional
params: Record<string, any>promise
Static
enableStatic
enableEnable livestream mode, in which the stream will be delivered to the invirtu RTMP endpoint for streaming.
The id of the event.
Optional
data: objectOptional
params: Record<string, any>promise
Static
enableEnables an overlay so that it will appear on screen.
The id of the event.
The id of the overlay.
Optional
data: objectOptional
params: Record<string, any>promise
Static
enableEnable a widget for the current event.
The id of the event to update.
The id of the widget to enable.
The data, which should contain the roles.
Optional
params: Record<string, any>promise
Static
getStatic
getStatic
listStatic
removeStatic
removeRTMPSourceRemove a RTMP source for multicasing.
The id of the event.
Optional
data: objectThe data to be passed when adding an RTMP source.
Optional
params: Record<string, any>promise
Static
sendStatic
sendSends content that will appear on-screen to the user.
The id of the event.
The information to send on-screen.
Optional
params: Record<string, any>promise
Static
setAIAccentSets the AI Avatars accent, that will dictate the void in which it responds.
The id of the event.
Optional
data: objectOptional
params: Record<string, any>promise
Static
setAIAvatarStatic
setAIAvatarSets the personality attribute of the AI to adjust how it will respond.
The id of the event.
Optional
data: objectOptional
params: Record<string, any>promise
Static
setAIAvatarSets the AI Avatar to that it willr respond to users in the chat.
The id of the event.
Optional
data: objectOptional
params: Record<string, any>promise
Static
setAIAvatarStatic
statisticsStatic
syncA function that should be run on an interval to set the event as live when the live stream is active.
The id of the event.
Optional
data: objectOptional
params: Record<string, any>promise
Static
updateStatic
updateThe event is synced with Invirtu for the lie streams. This will allow you to update
The id of the event to update.
The data to update.
Optional
params: Record<string, any>promise
Static
updateRTMPSourceUpdate an RTMP Source for multicasing.
The id of the event.
Optional
data: objectThe data to be passed when adding an RTMP source.
Optional
params: Record<string, any>promise
Static
updateUpdate a recording related to an event.
The id of the event to update.
The id of the recording to update.
The data to update.
Optional
params: Record<string, any>promise
Static
uploadUpdates the banner image for the event using a Blob.
The blob to upload.
Optional
data: objectAny additional data to pass along to the upload
Optional
params: Record<string, any>promise
Static
uploadUpdates the banner image for the event using a File object.
The file object to upload.
Optional
data: objectAny additional data to pass along to the upload.
Optional
params: Record<string, any>promise
Static
uploadUpdates the main image for the event using a Blob.
The blob to upload.
Optional
data: objectAny additional data to pass along to the upload
Optional
params: Record<string, any>promise
Static
uploadUpdates the main image for the event using a File object.
The file object to upload.
Optional
data: objectAny additional data to pass along to the upload.
Optional
params: Record<string, any>promise
Static
viewGenerated using TypeDoc
Add a Facebook Stream to the current event. The user must have authenticatd with Facebook.