Difference between revisions of "ISKernel:audio (Object Type)"
Jump to navigation
Jump to search
(Created page with "== Description == {{ObjectType-Vitals|audio|Inner Space|none|NULL|none|no|void*}} The audio object provides access to Inner Space's audio engine, as well as Windows Volume...") |
|||
Line 9: | Line 9: | ||
* [[ObjectType:float|float]] '''VolumeRight''': '''(Windows)''' Current Process right-channel volume level, as per Windows Volume Mixer. 0.0 for silent, 1.0 for full volume. | * [[ObjectType:float|float]] '''VolumeRight''': '''(Windows)''' Current Process right-channel volume level, as per Windows Volume Mixer. 0.0 for silent, 1.0 for full volume. | ||
* [[ObjectType:bool|bool]] '''IsMuted''': '''(Windows)''' Current Process Mute setting, as per Windows Volume Mixer | * [[ObjectType:bool|bool]] '''IsMuted''': '''(Windows)''' Current Process Mute setting, as per Windows Volume Mixer | ||
− | * audiovoice Voice[#]: Retrieves an Audio Voice (something that makes sounds) by ID | + | * audiovoice '''Voice['''#''']''': Retrieves an Audio Voice (something that makes sounds) by ID |
− | * audiovoice Voice[name]: Retrieves an Audio Voice (something that makes sounds) by name | + | * audiovoice '''Voice['''name''']''': Retrieves an Audio Voice (something that makes sounds) by name |
− | * jsonarray Voices: Retrieves a JSON array containing the list of currently available Voices (things that make sounds) | + | * jsonarray '''Voices''': Retrieves a JSON array containing the list of currently available Voices (things that make sounds) |
− | * audiostream Stream[#]: Retrieves an Audio Stream (a sound) by ID | + | * audiostream '''Stream['''#''']''': Retrieves an Audio Stream (a sound) by ID |
− | * audiostream Stream[name]: Retrieves an Audio Stream (a sound) by name | + | * audiostream '''Stream['''name''']''': Retrieves an Audio Stream (a sound) by name |
− | * jsonarray Streams: Retrieves a JSON array containing the list of currently available Streams (sounds) | + | * jsonarray '''Streams''': Retrieves a JSON array containing the list of currently available Streams (sounds) |
− | * [[ObjectType:float|float]] EngineVolume: The current Master volume level for Inner Space's audio engine | + | * [[ObjectType:float|float]] '''EngineVolume''': The current Master volume level for Inner Space's audio engine |
== Methods == | == Methods == | ||
− | * FadeVolume[#,seconds]: '''(Windows)''' Fades (adjusts) the Current Process volume level to the specified value, over the specified number of seconds. | + | * '''FadeVolume['''#''','''seconds''']''': '''(Windows)''' Fades (adjusts) the Current Process volume level to the specified value, over the specified number of seconds. |
− | * SetVolume[#]: '''(Windows)''' Sets the Current Process volume level to the specified value | + | * '''SetVolume['''#''']''': '''(Windows)''' Sets the Current Process volume level to the specified value |
− | * SetVolume[#,#]: '''(Windows)''' Sets the Current Process volume level to the specified left and right channel values | + | * '''SetVolume['''#''','''#''']''': '''(Windows)''' Sets the Current Process volume level to the specified left and right channel values |
− | * IncVolume[#]: '''(Windows)''' Increases the Current Process volume level by the specified value | + | * '''IncVolume['''#''']''': '''(Windows)''' Increases the Current Process volume level by the specified value |
− | * IncVolume[#,#]: '''(Windows)''' Increases the Current Process volume level by the specified left and right channel values | + | * '''IncVolume['''#''','''#''']''': '''(Windows)''' Increases the Current Process volume level by the specified left and right channel values |
− | * SetMute[bool]: '''(Windows)''' Sets the Current Process Mute setting | + | * '''SetMute['''bool''']''': '''(Windows)''' Sets the Current Process Mute setting |
− | * SetEngineVolume[#]: Sets the Master volume level for Inner Space's audio engine to the specified value | + | * '''SetEngineVolume['''#''']''': Sets the Master volume level for Inner Space's audio engine to the specified value |
− | * IncEngineVolume[#]: Increments the Master volume level for Inner Space's audio engine by the specified value | + | * '''IncEngineVolume['''#''']''': Increments the Master volume level for Inner Space's audio engine by the specified value |
− | * AddVoice[name]: Creates a new Audio Voice (thing that makes sounds) with the specified name | + | * '''AddVoice['''name''']''': Creates a new Audio Voice (thing that makes sounds) with the specified name |
− | * RemoveVoice[name]: Removes an Audio Voice with the specified name | + | * '''RemoveVoice['''name''']''': Removes an Audio Voice with the specified name |
− | * AddStream[name,filename]: Creates a new Audio Stream (a sound) with the specified name. The filename specifies the sound file to use for this stream. | + | * '''AddStream['''name''','''filename''']: Creates a new Audio Stream (a sound) with the specified name. The filename specifies the sound file to use for this stream. |
− | * RemoveStream[name]: Removes an Audio Stream with the specified name | + | * '''RemoveStream['''name''']''': Removes an Audio Stream with the specified name |
== See Also == | == See Also == |
Latest revision as of 17:20, 16 December 2019
Contents
Description
audio | |
Defined By | Inner Space |
Inherits | none |
Reduces To | NULL |
Variable Object Type | none |
Uses Sub-Types | no |
C/C++ Type | void* |
The audio object provides access to Inner Space's audio engine, as well as Windows Volume Mixer volume and mute controls.
Members
- float Volume: (Windows) Current Process volume level, as per Windows Volume Mixer. 0.0 for silent, 1.0 for full volume.
- float VolumeLeft: (Windows) Current Process left-channel volume level, as per Windows Volume Mixer. 0.0 for silent, 1.0 for full volume.
- float VolumeRight: (Windows) Current Process right-channel volume level, as per Windows Volume Mixer. 0.0 for silent, 1.0 for full volume.
- bool IsMuted: (Windows) Current Process Mute setting, as per Windows Volume Mixer
- audiovoice Voice[#]: Retrieves an Audio Voice (something that makes sounds) by ID
- audiovoice Voice[name]: Retrieves an Audio Voice (something that makes sounds) by name
- jsonarray Voices: Retrieves a JSON array containing the list of currently available Voices (things that make sounds)
- audiostream Stream[#]: Retrieves an Audio Stream (a sound) by ID
- audiostream Stream[name]: Retrieves an Audio Stream (a sound) by name
- jsonarray Streams: Retrieves a JSON array containing the list of currently available Streams (sounds)
- float EngineVolume: The current Master volume level for Inner Space's audio engine
Methods
- FadeVolume[#,seconds]: (Windows) Fades (adjusts) the Current Process volume level to the specified value, over the specified number of seconds.
- SetVolume[#]: (Windows) Sets the Current Process volume level to the specified value
- SetVolume[#,#]: (Windows) Sets the Current Process volume level to the specified left and right channel values
- IncVolume[#]: (Windows) Increases the Current Process volume level by the specified value
- IncVolume[#,#]: (Windows) Increases the Current Process volume level by the specified left and right channel values
- SetMute[bool]: (Windows) Sets the Current Process Mute setting
- SetEngineVolume[#]: Sets the Master volume level for Inner Space's audio engine to the specified value
- IncEngineVolume[#]: Increments the Master volume level for Inner Space's audio engine by the specified value
- AddVoice[name]: Creates a new Audio Voice (thing that makes sounds) with the specified name
- RemoveVoice[name]: Removes an Audio Voice with the specified name
- AddStream[name,filename]: Creates a new Audio Stream (a sound) with the specified name. The filename specifies the sound file to use for this stream.
- RemoveStream[name]: Removes an Audio Stream with the specified name
See Also