C# Class GAudio.AGATWrappedSample

Base class for playback of wrapped GATData and IGATProcessedSample objects

Mostra file Open project: gregzo/G-Audio

Public Properties

Property	Type	Description
panInfo	AGATPanInfo

Protected Properties

Property	Type	Description
_dataOwner	IGATDataOwner
_endDspTime	double
_shouldStop	bool

Public Methods

Method	Description
AGATWrappedSample ( IGATDataOwner dataOwner, AGATPanInfo ipaninfo = null ) : System.Collections	Data owners include IGATProcessedSample and GATData obects. Specify a GATDynamicPanInfo or GATFixedPanInfo object to enable routing playback directly to the player ( not through tracks ).
ElegantStop ( ) : void	Smoothly stops playback by fading out the audio data in audio buffer size ( non destructive, data is buffered before the fade ).
PlayPanned ( GATPlayer player, float gain = 1f ) : void	Plays the sample directly through the specified player If no AGATPanInfo reference was specified when creating the instance, doesn't do anything.
PlayPanned ( float gain = 1f ) : void	Plays the sample directly through the Default Player. If no AGATPanInfo reference was specified when creating the instance, doesn't do anything.
PlayScheduled ( GATPlayer player, double dspTime, float gain = 1f ) : void	Plays the sample directly through the specified player. If no AGATPanInfo reference was specified when creating the instance, doesn't do anything.
PlayScheduled ( double dspTime, float gain = 1f ) : void	Plays the sample directly through the Default Player. If no AGATPanInfo reference was specified when creating the instance, doesn't do anything.
PlayScheduledThroughTrack ( GATPlayer player, double dspTime, int trackNb, float gain = 1f ) : void	Plays the sample through the specified player's track trackNb
PlayScheduledThroughTrack ( double dspTime, int trackNb, float gain = 1f ) : void	Plays the sample through the default player's track trackNb
PlayThroughTrack ( GATPlayer player, int trackNb, float gain = 1f ) : void	Plays the sample through the specified player's track trackNb
PlayThroughTrack ( int trackNb, float gain = 1f ) : void	Plays the sample through the default player's track trackNb

Protected Methods

Method	Description
PlayerWillMixSample ( IGATBufferedSample sample, int length, float audioBuffer ) : bool

Method Details

AGATWrappedSample() public method

Data owners include IGATProcessedSample and GATData obects. Specify a GATDynamicPanInfo or GATFixedPanInfo object to enable routing playback directly to the player ( not through tracks ).

public AGATWrappedSample ( IGATDataOwner dataOwner, AGATPanInfo ipaninfo = null ) : System.Collections
dataOwner	IGATDataOwner
ipaninfo	AGATPanInfo
return	System.Collections

ElegantStop() public method

Smoothly stops playback by fading out the audio data in audio buffer size ( non destructive, data is buffered before the fade ).

public ElegantStop ( ) : void
return	void

PlayPanned() public method

Plays the sample directly through the specified player If no AGATPanInfo reference was specified when creating the instance, doesn't do anything.

public PlayPanned ( GATPlayer player, float gain = 1f ) : void
player	GATPlayer
gain	float
return	void

PlayPanned() public method

Plays the sample directly through the Default Player. If no AGATPanInfo reference was specified when creating the instance, doesn't do anything.

public PlayPanned ( float gain = 1f ) : void
gain	float
return	void

PlayScheduled() public method

Plays the sample directly through the specified player. If no AGATPanInfo reference was specified when creating the instance, doesn't do anything.

public PlayScheduled ( GATPlayer player, double dspTime, float gain = 1f ) : void
player	GATPlayer
dspTime	double
gain	float
return	void

PlayScheduled() public method

Plays the sample directly through the Default Player. If no AGATPanInfo reference was specified when creating the instance, doesn't do anything.

public PlayScheduled ( double dspTime, float gain = 1f ) : void
dspTime	double
gain	float
return	void

PlayScheduledThroughTrack() public method

Plays the sample through the specified player's track trackNb

public PlayScheduledThroughTrack ( GATPlayer player, double dspTime, int trackNb, float gain = 1f ) : void
player	GATPlayer
dspTime	double
trackNb	int
gain	float
return	void

PlayScheduledThroughTrack() public method

Plays the sample through the default player's track trackNb

public PlayScheduledThroughTrack ( double dspTime, int trackNb, float gain = 1f ) : void
dspTime	double
trackNb	int
gain	float
return	void

PlayThroughTrack() public method

Plays the sample through the specified player's track trackNb

public PlayThroughTrack ( GATPlayer player, int trackNb, float gain = 1f ) : void
player	GATPlayer
trackNb	int
gain	float
return	void

PlayThroughTrack() public method

Plays the sample through the default player's track trackNb

public PlayThroughTrack ( int trackNb, float gain = 1f ) : void
trackNb	int
gain	float
return	void

PlayerWillMixSample() protected abstract method

protected abstract PlayerWillMixSample ( IGATBufferedSample sample, int length, float audioBuffer ) : bool
sample	IGATBufferedSample
length	int
audioBuffer	float
return	bool

Property Details

_dataOwner protected_oe property

protected IGATDataOwner _dataOwner
return	IGATDataOwner

_endDspTime protected_oe property

protected double _endDspTime
return	double

_shouldStop protected_oe property

protected bool _shouldStop
return	bool

panInfo public_oe property

Use to manipulate gain per channel or stereo pan when not playing through a track. Requires a GATDynamicPanInfo reference to be passed when instantiating the class.

public AGATPanInfo,GAudio panInfo
return	AGATPanInfo