C# Class GAudio.GATFixedPanInfo

Use this class when you do not need a sample's gains per channel to change during playback. If you do need live pan control, use GATDynamicPanInfo instead. Note: GATPanInfo objects are only required when not routing playback through a GATTrack. Note 2: a single instance may be used to pan multiple concurrent samples.
Inheritance: AGATPanInfo
Show file Open project: gregzo/G-Audio

Public Properties

Property Type Description
channelGains List

Public Methods

Method Description
GATFixedPanInfo ( ) : System.Collections
GATFixedPanInfo ( float gains ) : System.Collections

Initializes a new instance of the GATFixedPanInfo class.
PanMixProcessingBuffer ( IGATBufferedSample sample, int length, float audioBuffer, float gain = 1f ) : void

This method may be used if you subscribe to GATPlayer's mixing delegate and choose to override default mixing.
PanMixSample ( IGATBufferedSample sample, int length, float audioBuffer, float gain = 1f ) : void

Called by GATPlayer to mix to interlaced data according to specified gains per channel. This method may be useful if you subscribe to GATPlayer's mixing delegate and choose to override default mixing.
SetGains ( float gains ) : void

Sets the gains for all channels. Can only be set once.

Method Details

GATFixedPanInfo() public method

public GATFixedPanInfo ( ) : System.Collections
return System.Collections

GATFixedPanInfo() public method

Initializes a new instance of the GATFixedPanInfo class.
/// Is thrown when the passed array's /// length does not match the number of /// channels your project is setup to output. ///
public GATFixedPanInfo ( float gains ) : System.Collections
gains float /// An array of gains indexed per channel. Silent channels /// should be represented by 0f gain values. ///
return System.Collections

PanMixProcessingBuffer() public method

This method may be used if you subscribe to GATPlayer's mixing delegate and choose to override default mixing.
public PanMixProcessingBuffer ( IGATBufferedSample sample, int length, float audioBuffer, float gain = 1f ) : void
sample IGATBufferedSample
length int
audioBuffer float
gain float
return void

PanMixSample() public method

Called by GATPlayer to mix to interlaced data according to specified gains per channel. This method may be useful if you subscribe to GATPlayer's mixing delegate and choose to override default mixing.
public PanMixSample ( IGATBufferedSample sample, int length, float audioBuffer, float gain = 1f ) : void
sample IGATBufferedSample
length int
audioBuffer float
gain float
return void

SetGains() public method

Sets the gains for all channels. Can only be set once.
/// Is thrown when attempting to /// set gains more than once, or if /// the provided gains array length /// does not match the number of channels /// your project is setup to output. ///
public SetGains ( float gains ) : void
gains float /// Gains per channel. Use 0f for /// silent channels. ///
return void

Property Details

channelGains public property

public List channelGains
return List