ScummVM API documentation
Sci::AudioChannel Struct Reference

#include <audio32.h>

Public Member Functions

AudioChanneloperator= (AudioChannel &other)
 

Public Attributes

ResourceId id
 
Resourceresource
 
Common::ScopedPtr< Audio::AudioStreamstream
 
Common::ScopedPtr< Audio::RateConverterconverter
 
uint32 duration
 
uint32 startedAtTick
 
uint32 pausedAtTick
 
uint32 fadeStartTick
 
int fadeStartVolume
 
uint32 fadeDuration
 
int fadeTargetVolume
 
bool stopChannelOnFade
 
bool robot
 
reg_t soundNode
 
int volume
 
int pan
 

Detailed Description

An audio channel used by the software SCI mixer.

Member Data Documentation

◆ id

ResourceId Sci::AudioChannel::id

The ID of the resource loaded into this channel.

◆ resource

Resource* Sci::AudioChannel::resource

The resource loaded into this channel. The resource is owned by ResourceManager.

◆ stream

Common::ScopedPtr<Audio::AudioStream> Sci::AudioChannel::stream

The audio stream loaded into this channel. Can cast to SeekableAudioStream for normal channels and RobotAudioStream for robot channels.

◆ converter

Common::ScopedPtr<Audio::RateConverter> Sci::AudioChannel::converter

The converter used to transform and merge the input stream into the mixer's output buffer.

◆ duration

uint32 Sci::AudioChannel::duration

Duration of the channel, in ticks.

◆ startedAtTick

uint32 Sci::AudioChannel::startedAtTick

The tick when the channel was started.

◆ pausedAtTick

uint32 Sci::AudioChannel::pausedAtTick

The tick when the channel was paused.

◆ fadeStartTick

uint32 Sci::AudioChannel::fadeStartTick

The time, in ticks, that the channel fade began. If 0, the channel is not being faded.

◆ fadeStartVolume

int Sci::AudioChannel::fadeStartVolume

The start volume of a fade.

◆ fadeDuration

uint32 Sci::AudioChannel::fadeDuration

The total length of the fade, in ticks.

◆ fadeTargetVolume

int Sci::AudioChannel::fadeTargetVolume

The end volume of a fade.

◆ stopChannelOnFade

bool Sci::AudioChannel::stopChannelOnFade

Whether or not the channel should be stopped and freed when the fade is complete.

◆ robot

bool Sci::AudioChannel::robot

Whether or not this channel contains a Robot audio block.

◆ soundNode

reg_t Sci::AudioChannel::soundNode

For digital sound effects, the related VM Sound::nodePtr object for the sound.

◆ volume

int Sci::AudioChannel::volume

The playback volume, from 1 to 127 inclusive.

◆ pan

int Sci::AudioChannel::pan

The amount to pan to the right, from 0 to 100. 50 is centered, -1 is not panned.


The documentation for this struct was generated from the following file: