livelike logo
Product
NPM
Versions

Interface IBaseCreateWidgetArg

Hierarchy

Properties

customData? interactiveUntil? playbackTimeMs? programDateTime? programId timeout? widgetAttributes?

Properties

Optional customData

customData?: string

custom data that could be added to set widget specific data, incase of JSON, stringify the JSON

Optional interactiveUntil

interactiveUntil?: Date

dateTime in UTC where after this dateTime, widget is not interactable

Optional playbackTimeMs

playbackTimeMs?: number

video playback time in milliseconds for showing widget for video on demand

Optional programDateTime

programDateTime?: string

program date time that could be used to sync up widget with your live streaming video

programId

programId: string

Id of the program in which widget is to be created

Optional timeout

timeout?: string

timeout duration for user till when the widget stays interactable in UI after getting rendered, value is in a ISO duration format

Optional widgetAttributes

widgetAttributes?: IAttribute[]

custom key value widget attributes

Settings

Member Visibility

Generated using TypeDoc