/
.Event.subscribe()

.Event.subscribe()

Owned by Konstantin Gnezdilov
Last updated: Mar 26, 2019 by Marius Bratu

Description

The method TouchCastPlayerAPI.Event.subscribe() allows you to subscribe to a range of events defined by the Player API, and run callback functions for when the event is fired.

TouchCastPlayerAPI.Event.subscribe(event, callback);

Parameters

NameDescriptionType
eventThe name of the event type you want to subscribe to. Click here for a list of all events.string
callbackThis is the callback function that is triggered when the event is fired. You can add multiple callbacks to the same event, by calling .Event.subscribe() again with a different callback. All the callbacks you've added will be triggered when the event takes place. See the table below Callback Parameters for a list of all the arguments the callback function will receive.function

Callback Parameters

NameDescriptionType
eAn object with these properties:
  • type[string] - the type of the event dispatched.
  • data[object] - This is an object with different properties and it's different based on the event type.
object


Output

This method has no output.


Example

TouchCastPlayerAPI.Event.subscribe(TouchCastPlayerAPI.events.VIDEO_ENDED, event_callback_video_ended);

function event_callback_video_ended (e) {
    // do something here
}