audio_stream_player

Types

AudioStreamPlayerObj {...}{.final.} = object of NodeObj
  paused*: bool
  volume*: cint
  stream*: AudioStreamRef
AudioStreamPlayerPtr = ptr AudioStreamPlayerObj

Procs

proc AudioStreamPlayer(name: string; variable: var AudioStreamPlayerObj): AudioStreamPlayerPtr {...}{.
    raises: [], tags: [].}

Creates a new AudioStreamPlayer pointer.

Arguments:

  • name is a node name.
  • variable is an AudioStreamPlayerObj variable

Examples:

var
  audio_obj: AudioStreamPlayerObj
  audio = AudioStreamPlayer("AudioStreamPlayer", audio_obj)
proc AudioStreamPlayer(variable: var AudioStreamPlayerObj): AudioStreamPlayerPtr {...}{.
    inline, raises: [], tags: [].}

Creates a new AudioStreamPlayer pointer width default name "AudioStreamPlayer".

Arguments:

  • variable is an AudioStreamPlayerObj variable

Examples:

var
  audio_obj: AudioStreamPlayerObj
  audio = AudioStreamPlayer(audio_obj)

Methods

method duplicate(self: AudioStreamPlayerPtr; obj: var AudioStreamPlayerObj): AudioStreamPlayerPtr {...}{.
    base, raises: [], tags: [].}
Duplicates AudioStreamPlayer object and create a new AudioStreamPlayer pointer.
method pause(self: AudioStreamPlayerPtr) {...}{.base, raises: [], tags: [].}
Pauses stream.
method play(self: AudioStreamPlayerPtr) {...}{.base, raises: [], tags: [].}
Play stream.
method resume(self: AudioStreamPlayerPtr) {...}{.base, raises: [], tags: [].}
Resume stream.
method setVolume(self: AudioStreamPlayerPtr; value: cint) {...}{.base, raises: [], tags: [].}

Changes stream volume.

Arguments:

  • volume is a number in range 0..128.