PlaybackEventsProvider
JS PlaybackEventsProvider
class exist for short term work around while TM APIs do not have support
for passing in nativeObjects from native side of TM into JS callback. Eventually will not need JS implementation
of IPlaybackEventsProvider
since a reference to a native PlaybackEventsProvider
will be provided instead.
When new JS PlaybackEventsProvider
is created a new native PlaybackEventsProvider
will be created and stored
in TM. JS PlaybackEventsProvider
uses TM to pass calls through to the native PlaybackEventsProvider
.
Implements
Constructors
new PlaybackEventsProvider()
new PlaybackEventsProvider(
providerId
):PlaybackEventsProvider
Parameters
providerId
number
Returns
Properties
providerId
providerId:
number
Methods
addPlaybackEventChunk()
addPlaybackEventChunk(
playbackEvents
):void
Adds playback event data to response.
Use repeated calls to addPlaybackEventChunk
to paginate data to prevent loading large lists into memory.
Must eventually be followed by a call to commit()
after all playback events have been sent.
Parameters
playbackEvents
A list of playback events.
Returns
void
Implementation of
IPlaybackEventsProvider
.addPlaybackEventChunk
commit()
commit():
void
Indicates the end of responses.
Must be called after the final call of addPlaybackEventChunk
.
Returns
void
Implementation of
IPlaybackEventsProvider
.commit
Last updated: Sep 30, 2025