Skip to main content

Types

This page is an index of types, interfaces, enums used across the Customization API

RtcRenderInterface

KeyTypeDescription
uidUidTypeuid of the user
audioToggleStateaudio mute state
videoToggleStatevideo mute state
streamType'high' | 'low'stream quality type
namestringdisplay name of the user
screenUidnumberuid of the screenshare stream
offlinebooleanoffline status of the user
type'rtc'content type

UserRenderInterface

Defined by the user, can contain any information necessary for the corresponding custom content added.

KeyTypeDescription
typestringContent of the chat message
[key: string]anyContent of the chat message

ToggleState

NameValue
disabled0
enabled1
disabling2
enabling3

ButtonTemplateName

NameValue
topBar0
bottomBar1

RenderObjects

KeyTypeDescription
[key: UidType]RenderInterfaceObject containing information necessary to render content view for the corresponding uid

UidType : string | number

Selector( e: T ): Partial<T>

Method to subscribe to portions of the app-state. When passed to an app-state accessor method it reicieves the contents of the associated app-state as argument, it must then selectively return the contents which are intended to be subscribed and eventually returned by the accessor method.

import { useRecording } from "customization-api";

const { isRecordingActive, startRecording } = useRecording(
({isRecordingActve ,startRecording, stopRecording}) => {
return({{isRecordingActve, startRecording}})
}
);

/*
#### RecordingContextInterface

isRecordingActve : boolean
startRecording : () => void
stopRecording : () => void
*/

DispatchType: <T, V>(action: { type: T; value: V }) => void

T: keyof CallbacksInterface

V: Parameters<CallbacksInterface[T]>

Used to dispatch various app builder actions. Part of RtcContext.

CallbacksInterface

KeyTypeDescription
EndCall() => voidEnds the call
SwitchCamera() => voidSwitches the video device being used [ mobile only ]
SwapVideo( uid: UidType ) => voidSwaps given uid with the uid at the top in renderPosition
DequeVideo( uid: UidType ) => voidShifts given uid to top of renderPosition
UpdateRenderList( uid: UidType, user: Partial<RenderInterface> ) => voidUpdates renderObject of the given uid in renderList
AddCustomContent( uid: UidType, data: RenderInterface ) => voidAdds the given data to renderlist with given uid as key. Used alongside CustomContent API for adding and displaying custom content