Interface IMediaControl
Web methods for playing media (audio/video) files embedded in the HTML page.
Namespace: HP.LFT.SDK.Web
Assembly: HP.LFT.SDK.dll
Syntax
public interface IMediaControlProperties
CurrentSource
The URL of this media file, which is currently selected in the browser window.
Declaration
string CurrentSource { get; }Property Value
| Type | Description |
|---|---|
| string |
Duration
The length of the currently selected media file (in milliseconds).
Declaration
uint Duration { get; }Property Value
| Type | Description |
|---|---|
| uint |
HasAutoPlay
Indicates whether this media file starts playing as soon as it loads.
Declaration
bool HasAutoPlay { get; }Property Value
| Type | Description |
|---|---|
| bool |
HasPlaybackControls
Indicates whether this media player should display playback controls.
Declaration
bool HasPlaybackControls { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsMuted
Indicates whether the media volume is muted.
Declaration
bool IsMuted { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsPlayInLoop
Indicates whether this media file should start playing again from the beginning as soon as it finishes playing.
Declaration
bool IsPlayInLoop { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsPlaying
Indicates whether this media file is currently playing.
Declaration
bool IsPlaying { get; }Property Value
| Type | Description |
|---|---|
| bool |
PlaybackRate
Indicates the speed of the media playback.
Declaration
double PlaybackRate { get; }Property Value
| Type | Description |
|---|---|
| double |
Remarks
Possible values: Numbers with up to two decimal places. For example, 0.51 or 1.00.
PlaybackTime
The current playback position in the media file (in milliseconds).
Declaration
uint PlaybackTime { get; }Property Value
| Type | Description |
|---|---|
| uint |
Sources
A collection of all media file source URLs.
Declaration
string[] Sources { get; }Property Value
| Type | Description |
|---|---|
| string[] |
Remarks
A media file may have multiple URL addresses for use in different browser types.
If the src attribute was set, but no sources were defined in the HTML, the Sources property will return a collection containing a single item with the "src" value.
Volume
Indicates the volume used when playing this media file.
Declaration
double Volume { get; }Property Value
| Type | Description |
|---|---|
| double |
Remarks
Possible values: Numbers with up to two decimal places. For example, 0.51 or 1.00.
Methods
Pause()
Pauses the media playback.
Declaration
void Pause()Play()
Plays the media file.
Declaration
void Play()Reload()
Reloads the media file.
Declaration
void Reload()