Copy of roStreamQueueEvent (DOCS-394)


This event object is generated by an roStreamQueue object when the end of the queue is reached.

ifUserData

SetUserData(user_data As Object) As Void

Sets the user data.

GetUserData() As Object

Returns the user data that has previously been set via SetUserData() (on either the event or source object). It will return Invalid if no data has been set.

ifStreamQueueEvent

GetData() As Object

Returns an roAssociativeArray with two entries, action and file:

  • action  contains one of:

    • START: indicates that playback of a queued file has been started
    • SKIP: indicates that a file in the queue has been skipped
    • END: indicates that a file has finished playing
  • file contains the name of the file whose state is returned in action.