Interface ISGIAudioResource

Interface representing audio resource functionality.

interface ISGIAudioResource {
    GetMetaData(): any;
    IsPlaying(): boolean;
    MaxSimulStreams(): number;
    Stop(): any;
    Trigger(volume: number): any;
    Trigger(volume: number, index: number): any;
}

Hierarchy (View Summary)

ISGIAudioResource
- ISGROAudioResource

Index

Methods

GetMetaData IsPlaying MaxSimulStreams Stop Trigger

Methods

GetMetaData

GetMetaData(): any
Gets metadata

Returns any
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:801

IsPlaying

IsPlaying(): boolean
Checks if audio is playing

Returns boolean
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:803

MaxSimulStreams

MaxSimulStreams(): number
Gets maximum simultaneous streams

Returns number
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:805

Stop

Stop(): any
Stops the audio

Returns any
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:807

Trigger

Trigger(volume: number): any
Triggers audio playback with volume
Parameters
- volume: number
Returns any
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:809
Trigger(volume: number, index: number): any
Triggers audio playback with volume and index
Parameters
- volume: number
- index: number
Returns any
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:811

Interface ISGIAudioResource

Hierarchy (View Summary)

Index

Methods

Methods

GetMetaData

Returns any

IsPlaying

Returns boolean

MaxSimulStreams

Returns number

Stop

Returns any

Trigger

Parameters

Returns any

Parameters

Returns any

Settings

On This Page