Class SampleInfo

Used with SampleGetInfo(Int32, ref SampleInfo) and SampleSetInfo(Int32, SampleInfo) to retrieve and set the default playback attributes of a sample.

Inheritance

Object

SampleInfo

Namespace: System.Dynamic.ExpandoObject

Assembly: ManagedBass.dll

Syntax

public class SampleInfo : object

Remarks

When a sample has 3D functionality, the InsideAngle and OutsideAngle angles decide how wide the sound is projected around the orientation angle (as set via ChannelSet3DPosition(Int32, Vector3D, Vector3D, Vector3D)). Within the inside angle the volume level is the level set in the volume member (or the Volume attribute when the sample is playing). Outside the outer angle, the volume changes according to the outvol value. Between the inner and outer angles, the volume gradually changes between the inner and outer volume levels. If the inner and outer angles are 360 degrees, then the sound is transmitted equally in all directions.

When VAM is enabled, and neither the Hardware or Software flags are specified, then the sample will be played in hardware if resources are available, and in software if no hardware resources are available.

Fields

Channels

Number of channels... 1=mono, 2=stereo (default), etc.

Declaration

public int Channels

Field Value

Int32

Flags

A combination of BassFlags.

Declaration

public BassFlags Flags

Field Value

BassFlags

Frequency

Default playback rate (set to 44100 by default).

Declaration

public int Frequency

Field Value

Int32

InsideAngle

The angle of the inside projection cone in degrees... 0 (no cone, default) - 360 (sphere).

Declaration

public int InsideAngle

Field Value

Int32

Length

The Length in bytes.

Declaration

public int Length

Field Value

Int32

Max

Maximum number of simultaneous playbacks (defaulted to 1).

Declaration

public int Max

Field Value

Int32

MaxDistance

The maximum distance (default 0). The sample's volume stops decreasing when the listener is beyond this distance.

Declaration

public float MaxDistance

Field Value

Single

MinDistance

The minimum distance (default 0). The sample's volume is at maximum when the listener is within this distance.

Declaration

public float MinDistance

Field Value

Single

MinGap

Minimum time gap in milliseconds between creating channels using SampleGetChannel(Int32, Boolean). This can be used to prevent flanging effects caused by playing a sample multiple times very close to eachother. The default setting, when loading/creating a sample, is 0 (disabled).

Declaration

public int MinGap

Field Value

Int32

Mode3D

The 3D processing mode...

Declaration

public Mode3D Mode3D

Field Value

Mode3D

OriginalResolution

The original resolution (bits per sample)... 0 = undefined (default).

Declaration

public int OriginalResolution

Field Value

Int32

OutsideAngle

The angle of the outside projection cone in degrees... 0 (no cone, default) - 360 (sphere).

Declaration

public int OutsideAngle

Field Value

Int32

OutsideVolume

The delta-volume outside the outer projection cone... 0 (silent) to 1 (full, default) - same as inside the cone.

Declaration

public float OutsideVolume

Field Value

Single

Pan

Default panning position -1 (full left) to +1 (full right) - defaulted to 0 = centre.

Declaration

public float Pan

Field Value

Single

Priority

Priority, used with the TerminatePriority flag... 0 (min, default) - 0xFFFFFFFF (max)

Declaration

public int Priority

Field Value

Int32

VAM

The sample's DX7 voice allocation/management settings (if VAM is enabled)...a combination of VAMMode flags.

Declaration

public VAMMode VAM

Field Value

VAMMode

Volume

Default volume... 0 (silent) to 1 (full, default).

Declaration

public float Volume

Field Value

Single