MPfm: Music Player for Musicians - Developer Documentation - 0.6.0.0
Channel Class
NamespacesMPfm.Sound.BassNetWrapperChannel
Defines a channel/stream to be used with BASS.NET. If you need to create a mixer channel, use the MixerChannel class.
Declaration Syntax
C#Visual Basic
public class Channel
Public Class Channel
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
Channel(Int32, ChannelType, Boolean, Boolean)
Default constructor for the Channel class. To create a new channel, use one of the static methods of this class.

AddChannel(Int32)
Adds a source channel to the mixer. Only for mixer channels.

Bytes2Seconds(Int64)
Converts bytes into milliseconds using the current channel properties.

channelType
Private value for the ChannelType property.

ChannelType
Indicates the type of channel (playback, FX, etc.)

CreateFileStreamForDecoding(String, Boolean)
Creates a stream from file for decoding.

CreateStream(Int32, Int32, Boolean, STREAMPROC)
Creates a stream from memory using a custom callback procedure.

CreateStreamForTimeShifting(Int32, Boolean, Boolean)
Creates a stream for FX (such as time shifting). It needs an handle to the decode stream in order to work.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Free()()()()
Frees the stream.

GetAttribute(BASSAttribute, Single%)
Gets an attribute value of the current channel (specified in the attribute property). Returns the attribute value in the value property.

GetData(array<Byte>[]()[][], Int32)
Gets data from the channel/stream buffer.

GetData(IntPtr, Int32)
Gets data from the channel/stream buffer.

GetData(array<Single>[]()[][], Int32)
Gets data from the channel/stream buffer.

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetLength()()()()
Gets the length of the channel in bytes.

GetMixerData(array<Single>[]()[][], Int32)
Gets data from a mixer channel/stream buffer.

GetPosition()()()()
Returns the current position of the channel/stream in bytes.

GetSampleRate()()()()
Returns the sample rate of the current channel.

GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
handle
Private value for the Handle property.

Handle
Handle to the channel.

IsActive()()()()
Indicates if the channel/stream is currently active or stopped.

isDecode
Private value for the IsDecode property.

IsDecode
Indicates if the channel/stream is decoding.

isFloatingPoint
Private value for the IsFloatingPoint property.

IsFloatingPoint
Indicates if the channel/stream is using floating point.

Lock(Boolean)
Locks or unlocks the position of the channel.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Pause()()()()
Pauses the playback of a channel.

Play(Boolean)
Starts the playback of a channel.

RemoveFX(Int32)
Removes an effect from the current channel.

RemoveSync(Int32)
Removes a synchronization callback.

ResetFX(Int32)
Resets the settings of an effect on the current channel.

sampleRate
Private value for the SampleRate property.

SampleRate
Defines the sample rate used for the channel. To fetch the "live" sample rate, use GetSampleRate(). To set the sample rate, use SetSampleRate(). This will also set this value.

Seconds2Bytes2(Double)
Converts milliseconds into bytes using the current channel properties.

SetAttribute(BASSAttribute, Single)
Sets an attribute value of the current channel (specified in the attribute property).

SetFlags(BASSFlag, BASSFlag)
Sets a flag on the current channel (specified in the flags property).

SetFX(BASSFXType, Int32)
Sets an effect on the current channel.

SetPosition(Int64)
Sets the position of the channel/stream in bytes.

SetSampleRate(Int32)
Sets the sample rate of the current channel.

SetSync(BASSSync, Int64, SYNCPROC)
Sets a synchronization callback.

SetTempo(Single)
Sets the "tempo" of the current channel (for time shifting). Note: needs to be an FX channel.

Stop()()()()
Stops the playback of a channel.

ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Volume
Gets/sets the volume of the channel using GetAttribute/SetAttribute with the attribute BASS_ATTRIB_VOL.

Inheritance Hierarchy

Assembly: MPfm.Sound (Module: MPfm.Sound) Version: 0.5.3.0 (0.5.3.0)