Roku SDK Documentation : ifAudioPlayer

Implemented By

• roAudioPlayer

Supported Methods

Descriptions of Methods

SetContentList(contentList as Object) as Void

Set the content list to be played by the Audio Player. The caller passes an Array of AssociativeArrays (Content Meta-Data objects) representing the information for each stream to be played. See Content Meta-Data for details on the attributes for each element in the array.

AddContent(contentItem as Object) as Void

Add a new ContentMetaData item to the content list for the Audio Player. The new item is added to the end of the content list.

ClearContent() as Void

Clear the content list.

Play() as Boolean

Put the Audio Player into play mode starting at the current item in the Content List. This will stop any currently playing content.

Stop() as Boolean

Stop Audio Player from playing or pausing and cleanup.

Pause() as Boolean

Put Audio Player into pause mode.  It is an error to Pause if player is not in play mode.

Resume() as Boolean

Put Audio Player into play mode starting from the pause point.  It is an error to Resume if the player is not in pause mode.

SetLoop(enable as Boolean) as Void

Enable/disable the automatic replaying of the Content List.  When enabled, after playing the last item in the content list, the player begins playing the first item.  When disabled, after playing the last item in the content list, the player stops.

SetNext(item as Integer) as Void

Set what the next item to be played within the Content List should be.  item is the zero-based index of the item in the content list.  This item will be played after the currently playing item finishes.

Seek(offsetMs as Integer) as Boolean

Set the start point of playback for the current item to offsetMs milliseconds. If the item is currently playing, playback will be interrupted and will restart at the specified offset.  If the item is not currently playing, playback will begin at the specified offset when Play() is called.

SetTimedMetaDataForKeys(keys[] as Dynamic) as Void

This method is called to specify the timedMetaData keys that the BrightScript channel is interested in receiving from the timedMetaData event.  If the keys array is empty, all the timed metadata associated with the current stream is sent with the isTimedMetaData event.  If the keys array is invalid, then do not return any keys to the BrightScript channel.  Any keys not specified with this method are deleted by the firmware and never returned to the BrightScript application.