Interface AudioTrack

interface represents audio track interface. Subinterface of Media

Hierarchy

Methods

asMedia getCurrentTrack getEndPosition getStartPosition getVolume isLooped isPlaying load pause play resume setEndPosition setLooped setStartPosition setVolume stop

Methods

asMedia

  • cast AudioTrack to Media parent interface.

    Returns Media

getCurrentTrack

  • Returns string

    current loaded audio track.

getEndPosition

  • Returns number

    playback end position

getStartPosition

getVolume

  • Returns number

    current audio track playback volume

isLooped

  • Returns boolean

    loop playback flag

isPlaying

  • Returns boolean

    playback active flag.

load

  • Load audio track file. For now only supports .m4a, .ogg, .mp3 files.

    Parameters

    • file: string

      absolute path for audio track file.

    Returns void

pause

  • pause Video playback

    Returns void

play

  • starts Video playback

    Returns void

resume

  • resume paused Video playback

    Returns void

setEndPosition

  • set playback end position.

    Parameters

    • position: number

      playback end position

    Returns void

setLooped

  • set playback looping.

    Parameters

    • looped: boolean

      loop playback flag

    Returns void

setStartPosition

  • set playback start position.

    Parameters

    • position: number

      playback start position

    Returns void

setVolume

  • set current audio track playback volume.

    Parameters

    • volume: number

      new audio volume. must be in range [0, 1]

    Returns void

stop

  • stop Video playback

    Returns void

Settings

Theme

On This Page