sound

module ‘sound’

Source file: prog/gameLibs/soundSystem/quirrel/soundSystemSq.cpp

Usage:

let { INVALID_SOUND_HANDLE, SOUND_STREAM_ERROR, SOUND_STREAM_CLOSED, SOUND_STREAM_OPENED, SOUND_STREAM_CONNECTING, SOUND_STREAM_BUFFERING, SOUND_STREAM_STOPPED, SOUND_STREAM_PAUSED, SOUND_STREAM_PLAYING, sound_debug_trace, sound_play_one_shot_3d, sound_play_one_shot, sound_release_all_instances, sound_play, sound_set_volume, sound_init_event, sound_release_event, sound_set_3d_attr, sound_set_var, sound_get_length, sound_set_timeline_pos, sound_get_timeline_pos, sound_start, sound_keyoff, sound_abandon, sound_is_playing, sound_init_stream, sound_open_stream, sound_close_stream, sound_set_stream_pos, sound_release_stream, sound_get_stream_state, sound_get_stream_state_name, sound_get_output_devices, sound_get_record_devices, sound_set_output_device, sound_set_callbacks } = require("sound")

or:

from "sound" import *

//'sound' exports:
{
  value INVALID_SOUND_HANDLE
  value SOUND_STREAM_ERROR
  value SOUND_STREAM_CLOSED
  value SOUND_STREAM_OPENED
  value SOUND_STREAM_CONNECTING
  value SOUND_STREAM_BUFFERING
  value SOUND_STREAM_STOPPED
  value SOUND_STREAM_PAUSED
  value SOUND_STREAM_PLAYING
  function sound_debug_trace(text): string -> null
  function sound_play_one_shot_3d(name, &pos): string, integer -> null
  function sound_play_one_shot(name): string -> null
  function sound_release_all_instances(name): string -> null
  function sound_play(arg0, ...): string, any_type -> _undocumented_
  function sound_set_volume(snd, volume): string, float -> null
  function sound_init_event(name, path): string, string -> sound_handle_t
  function sound_release_event(event_handle): sndsys::sound_handle_t -> null
  function sound_set_3d_attr(event_handle, &pos): sndsys::sound_handle_t, integer -> null
  function sound_set_var(event_handle, var_name, value): sndsys::sound_handle_t, string, float -> null
  function sound_get_length(name): string -> integer
  function sound_set_timeline_pos(event_handle, position): sndsys::sound_handle_t, integer -> null
  function sound_get_timeline_pos(event_handle): sndsys::sound_handle_t -> integer
  function sound_start(event_handle): sndsys::sound_handle_t -> null
  function sound_keyoff(event_handle): sndsys::sound_handle_t -> bool
  function sound_abandon(event_handle, delay): sndsys::sound_handle_t, float -> null
  function sound_is_playing(event_handle): sndsys::sound_handle_t -> bool
  function sound_init_stream(url, &min_max_distance): string, integer -> sound_handle_t
  function sound_open_stream(stream_handle): sndsys::sound_handle_t -> null
  function sound_close_stream(stream_handle): sndsys::sound_handle_t -> null
  function sound_set_stream_pos(stream_handle, &pos): sndsys::sound_handle_t, integer -> null
  function sound_release_stream(stream_handle): sndsys::sound_handle_t -> null
  function sound_get_stream_state(stream_handle): sndsys::sound_handle_t -> StreamState
  function sound_get_stream_state_name()
  function sound_get_output_devices()
  function sound_get_record_devices()
  function sound_set_output_device(dev_id): integer -> null
  function sound_set_callbacks(callbacks_): sqObject -> null
}

INVALID_SOUND_HANDLE

SOUND_STREAM_ERROR

SOUND_STREAM_CLOSED

SOUND_STREAM_OPENED

SOUND_STREAM_CONNECTING

SOUND_STREAM_BUFFERING

SOUND_STREAM_STOPPED

SOUND_STREAM_PAUSED

SOUND_STREAM_PLAYING

function sound_debug_trace(text)

Arguments:

text (string()) –

Returns:

null

function sound_play_one_shot_3d(name, &pos)

Arguments:

name (string()) –
&pos (integer()) –

Returns:

null

function sound_play_one_shot(name)

Arguments:

name (string()) –

Returns:

null

function sound_release_all_instances(name)

Arguments:

name (string()) –

Returns:

null

function sound_play(arg0, ...)

Arguments:

arg0 (string()) – autodoc from typemask/paramscheck
... (any_type()) – this function accepts unlimited arguments

nparamscheck:-2

typecheck mask: any_type, string

function sound_set_volume(snd, volume)

Arguments:

snd (string()) –
volume (float()) –

Returns:

null

function sound_init_event(name, path)

Arguments:

name (string()) –
path (string()) –

Returns:

sound_handle_t

function sound_release_event(event_handle)

Arguments:

event_handle (sndsys::sound_handle_t()) –

Returns:

null

function sound_set_3d_attr(event_handle, &pos)

Arguments:

event_handle (sndsys::sound_handle_t()) –
&pos (integer()) –

Returns:

null

function sound_set_var(event_handle, var_name, value)

Arguments:

event_handle (sndsys::sound_handle_t()) –
var_name (string()) –
value (float()) –

Returns:

null

function sound_get_length(name)

Arguments:

name (string()) –

Returns:

integer

function sound_set_timeline_pos(event_handle, position)

Arguments:

event_handle (sndsys::sound_handle_t()) –
position (integer()) –

Returns:

null

function sound_get_timeline_pos(event_handle)

Arguments:

event_handle (sndsys::sound_handle_t()) –

Returns:

integer

function sound_start(event_handle)

Arguments:

event_handle (sndsys::sound_handle_t()) –

Returns:

null

function sound_keyoff(event_handle)

Arguments:

event_handle (sndsys::sound_handle_t()) –

Returns:

bool

function sound_abandon(event_handle, delay)

Arguments:

event_handle (sndsys::sound_handle_t()) –
delay (float()) –

Returns:

null

function sound_is_playing(event_handle)

Arguments:

event_handle (sndsys::sound_handle_t()) –

Returns:

bool

function sound_init_stream(url, &min_max_distance)

Arguments:

url (string()) –
&min_max_distance (integer()) –

Returns:

sound_handle_t

function sound_open_stream(stream_handle)

Arguments:

stream_handle (sndsys::sound_handle_t()) –

Returns:

null

function sound_close_stream(stream_handle)

Arguments:

stream_handle (sndsys::sound_handle_t()) –

Returns:

null

function sound_set_stream_pos(stream_handle, &pos)

Arguments:

stream_handle (sndsys::sound_handle_t()) –
&pos (integer()) –

Returns:

null

function sound_release_stream(stream_handle)

Arguments:

stream_handle (sndsys::sound_handle_t()) –

Returns:

null

function sound_get_stream_state(stream_handle)

Arguments:

stream_handle (sndsys::sound_handle_t()) –

Returns:

StreamState

function sound_get_stream_state_name()

function sound_get_output_devices()

nparamscheck:1

typecheck mask: any_type

function sound_get_record_devices()

nparamscheck:1

typecheck mask: any_type

function sound_set_output_device(dev_id)

Arguments:

dev_id (integer()) –

Returns:

null

function sound_set_callbacks(callbacks_)

Arguments:

callbacks (sqObject()) –

Returns:

null

/;

return soundTbl;

}