McBasic™ 0.7.881 · Build 881 · 9 min read

Media · Visual control

AudioPlayer

Handle loading, playback, completion and failure as separate states.

39 properties15 events4 methodsDefault: Completed

Build the AudioPlayer lesson Properties Events Methods

Use it in a Form#

The media source must be available to the running app. Loaded does not mean playback has completed; StateChanged is not a substitute for Failed. Keep the error visible and avoid automatically retrying a bad source in a tight loop.

Add AudioPlayer to its intended parent and name it audTone for this example:

Property	Example value
`Source`	`"Tone"`
`AutoPlay`	`False`
`Loop`	`False`
`Volume`	`0.35`

A complete handler from Forms/frmMain.bas. The linked lesson includes its surrounding controls, declarations and helpers.

Forms/frmMain.bas

Private Sub audTone_Loaded()
    lblStatus.Caption = "Loaded " + audTone.Source
    lblPosition.Caption = "Duration: " + CStr(audTone.Duration) + " seconds"
End Sub

Properties#

Contract defaults are shown below. Where a new control has a different Designer starting value, that value is listed separately.

`Left`

DoubleDefault: 0

Horizontal position in device-independent points, relative to the parent container.

Range: -100000 to 100000.

`Top`

DoubleDefault: 0

Vertical position in device-independent points, relative to the parent container.

Range: -100000 to 100000.

`Width`

DoubleDefault: 380

Control width in device-independent points.

Range: 0 to 100000.

`Height`

DoubleDefault: 84

Control height in device-independent points.

Range: 0 to 100000.

`MinWidth`

DoubleDefault: 0

Minimum control width in device-independent points; 0 lets the parent layout choose.

Range: 0 to 100000.

`MinHeight`

DoubleDefault: 0

Minimum control height in device-independent points; 0 lets the parent layout choose.

Range: 0 to 100000.

`MaxWidth`

DoubleDefault: 100000

Maximum control width in device-independent points.

Range: 0 to 100000.

`MaxHeight`

DoubleDefault: 100000

Maximum control height in device-independent points.

Range: 0 to 100000.

`TabIndex`

LongDefault: 0

Keyboard navigation order within the parent container; lower values come first.

Range: 0 to 100000.

`ZIndex`

LongDefault: 0

Stacking order among sibling controls; larger values appear in front. Equal values preserve document order.

Range: -100000 to 100000.

`Anchor`

StringDefault: "Left,Top"Not in InspectorNot serialized

Edges kept at their authored distance when the parent resizes. Use a comma-separated combination of Left, Top, Right and Bottom; Dock overrides the effective anchor without deleting it.

`Dock`

StringDefault: "None"

Automatic placement within the parent: None, Left, Top, Right, Bottom or Fill. Dock overrides effective Anchor layout without deleting the stored anchors.

`Visible`

BooleanDefault: True

Whether the control is shown in the running application.

`Enabled`

BooleanDefault: True

Whether the control accepts user interaction in the running application.

`HitTestVisible`

BooleanDefault: True

Whether the running control participates in pointer hit testing. The control remains selectable in the Designer.

`AllowDrop`

BooleanDefault: False

Whether this running control accepts application drag-and-drop operations; Designer movement is separate.

`DragMode`

LongDefault: 0

VB control drag: 0 Manual (code starts a drag with the Drag method) or 1 Automatic (a left-button press starts a drag, and the control raises no Click, MouseDown or MouseUp for that press).

Range: 0 to 1.

`DragIcon`

StringDefault: ""

Case-insensitive name of a declared project image resource shown under the pointer while this control is dragged; empty shows a grey outline of the control.

`Margin`

StringDefault: "0"

External spacing as one non-negative DIP value or Left,Top,Right,Bottom.

`Cursor`

StringDefault: "Default"

Pointer shown over the control: Default, Arrow, Hand, IBeam, Cross, Wait, Help, SizeAll, SizeNS, SizeWE, SizeNWSE, SizeNESW or NotAllowed.

`Opacity`

DoubleDefault: 1

Visual opacity from 0 (transparent) to 1 (opaque).

Range: 0 to 1.

`DesignLocked`

BooleanDefault: FalseDesigner only

Prevents movement and resizing in the Designer without changing runtime interaction.

`AccessibleDescription`

StringDefault: ""

Additional help text announced by assistive technology.

`AutomationId`

StringDefault: ""

Stable automation identifier; empty uses the component Name.

`AccessibleName`

StringDefault: ""

Name announced by assistive technology. Empty uses the stable control Name.

`AccessibleRole`

StringDefault: "Auto"

Accessibility role override. Auto preserves the native semantic role; explicit values use the corresponding platform automation role.

`ToolTipText`

StringDefault: ""

Help text shown when the pointer rests over the running control; empty disables the tooltip.

`Tag`

StringDefault: ""

Application-defined text associated with this control; McBasic™ does not interpret it.

`Source`

StringDefault: ""

Logical name of a declared project audio resource. No filesystem path is exposed to BASIC.

`AutoPlay`

BooleanDefault: False

Starts playback after the owning Form becomes active.

`Loop`

BooleanDefault: False

Restarts playback after the final sample.

`Volume`

DoubleDefault: 1

Playback volume from 0 (silent) through 1 (full component volume).

Range: 0 to 1.

`Position`

DoubleDefault: 0Not in InspectorNot serialized

Current playback position in seconds. BASIC may seek within Duration.

Range: 0 to 86400.

`Duration`

DoubleDefault: 0Read only in BASICNot in InspectorNot serialized

Read-only loaded audio duration in seconds.

Range: 0 to 86400.

`Playing`

BooleanDefault: FalseRead only in BASICNot in InspectorNot serialized

Read-only active playback state.

`Paused`

BooleanDefault: FalseRead only in BASICNot in InspectorNot serialized

Read-only paused playback state.

`State`

StringDefault: "Empty"Read only in BASICNot in InspectorNot serialized

Read-only state: Empty, Loaded, Playing, Paused, Stopped, Completed or Error.

`Error`

StringDefault: ""Read only in BASICNot in InspectorNot serialized

Read-only load or playback error.

`Index`

LongDefault: -1Read only in BASICDesigner Index row

Position of this control in its control array, 0 to 32767. Several controls share one name only when every one of them has an Index. Absent from the layout, and -1 in code, when the control is not in an array.

Designer values: 0 to 32767. Clear the dedicated Index row for a non-array control; BASIC then reads -1.

Events and parameters#

Replace control with the object’s Name when creating a handler. ByRef arguments may be changed by your handler; ByVal arguments report an input value.