Media Player

Media Player

Choose your operating system:

Windows

macOS

Linux

On this page

Actions

Can Pause

Check whether media playback can be paused right now.

Playback can be paused if the media supports pausing and if it is currently playing.

Target is Media Player

Can Play Source

Check whether the specified media source can be played by this player.

If a desired player name is set for this player, it will only check whether that particular player type can play the specified source.

Target is Media Player

Can Play Url

Check whether the specified URL can be played by this player.

If a desired player name is set for this player, it will only check whether that particular player type can play the specified URL.

Target is Media Player

Close

Close the currently open media, if any.

See: OnMediaClosed, OpenPlaylist, OpenPlaylistIndex, OpenSource, OpenUrl, Pause, Play

Target is Media Player

Get Audio Track Channels

Get the number of channels in the specified audio track.

Target is Media Player

Get Audio Track Sample Rate

Get the sample rate of the specified audio track.

Target is Media Player

Get Audio Track Type

Get the type of the specified audio track format.

Target is Media Player

Get Desired Player Name

Get the name of the current desired native player.

Target is Media Player

Get Duration

Get the media's duration.

Target is Media Player

Get Horizontal Field Of View

Get the current horizontal field of view (only for 360 videos).

Target is Media Player

Get Media Name

Get the human readable name of the currently loaded media source.

Target is Media Player

Get Num Track Formats

Get the number of formats of the specified track.

Target is Media Player

Get Num Tracks

Get the number of tracks of the given type.

Target is Media Player

Get Player Name

Get the name of the current native media player.

Target is Media Player

Get Playlist

Get the current play list.

Media players always have a valid play list. In C++ code you can use the GetPlaylistRef to get a reference instead of a pointer to it.

Target is Media Player

Get Playlist Index

Get the current play list index.

Target is Media Player

Get Rate

Get the media's current playback rate.

Target is Media Player

Get Selected Track

Get the index of the currently selected track of the given type.

Target is Media Player

Get Supported Rates

Get the supported playback rates.

Target is Media Player

Get Time

Get the media's current playback time.

Target is Media Player

Get Time Delay

Delay of the player's time.

Target is Media Player

Get Time Stamp

Get the media's current playback timestamp.

Target is Media Player

Get Track Display Name

Get the human readable name of the specified track.

Target is Media Player

Get Track Format

Get the index of the active format of the specified track type.

Target is Media Player

Get Track Language

Get the language tag of the specified track.

Target is Media Player

Get Url

Get the URL of the currently loaded media, if any.

Target is Media Player

Get Vertical Field Of View

Get the current vertical field of view (only for 360 videos).

Target is Media Player

Get Video Track Aspect Ratio

Get the aspect ratio of the specified video track.

Target is Media Player

Get Video Track Dimensions

Get the current dimensions of the specified video track.

Target is Media Player

Get Video Track Frame Rate

Get the frame rate of the specified video track.

Target is Media Player

Get Video Track Frame Rates

Get the supported range of frame rates of the specified video track.

Target is Media Player

Get Video Track Type

Get the type of the specified video track format.

Target is Media Player

Get View Rotation

Get the current view rotation (only for 360 videos).

Target is Media Player

Has Error

Check whether the player is in an error state.

When the player is in an error state, no further operations are possible. The current media must be closed, and a new media source must be opened before the player can be used again. Errors are usually caused by faulty media files or interrupted network connections.

See: IsReady

Target is Media Player

Is Buffering

Check whether playback is buffering data.

Target is Media Player

Is Closed

Whether media is currently closed.

Target is Media Player

Is Connecting

Check whether the player is currently connecting to a media source.

Target is Media Player

Is Looping

Check whether playback is looping.

Target is Media Player

Is Paused

Check whether playback is currently paused.

Target is Media Player

Is Playing

Check whether playback has started.

Target is Media Player

Is Preparing

Check whether the media is currently opening or buffering.

Target is Media Player

Is Ready

Check whether media is ready for playback.

A player is ready for playback if it has a media source opened that finished preparing and is not in an error state.

Target is Media Player

Next

Open the next item in the current play list.

The player will start playing the new media source if it was playing something previously, otherwise it will only open the media source.

Target is Media Player

On End Reached

On End Reached: A delegate that is invoked when playback has reached the end of the media.

On Media Closed

On Media Closed: A delegate that is invoked when a media source has been closed.

On Media Open Failed

On Media Open Failed: A delegate that is invoked when a media source has failed to open.

This delegate is only executed if OpenSource / OpenUrl returned true and the media failed to open asynchronously later. It is not executed if OpenSource / OpenUrl returned false, indicating an immediate failure.

@see OnMediaOpened

On Media Opened

On Media Opened: A delegate that is invoked when a media source has been opened.

Depending on whether the underlying player implementation opens the media synchronously or asynchronously, this event may be executed before or after the call to OpenSource / OpenUrl returns.

@see OnMediaOpenFailed, OnTracksChanged

On Playback Resumed

On Playback Resumed: A delegate that is invoked when media playback has been resumed.

@see OnPlaybackSuspended

On Playback Suspended

On Playback Suspended: A delegate that is invoked when media playback has been suspended.

@see OnPlaybackResumed

On Seek Completed

On Seek Completed: A delegate that is invoked when a seek operation completed successfully.

Depending on whether the underlying player implementation performs seeks synchronously or asynchronously, this event may be executed before or after the call to Seek returns.

On Tracks Changed

On Tracks Changed: A delegate that is invoked when the media track collection changed.

@see OnMediaOpened

Open File

Opens the specified media file path.

A return value of true indicates that the player will attempt to open the media, but it may fail to do so later for other reasons, i.e. if a connection to the media server timed out. Use the OnMediaOpened and OnMediaOpenFailed delegates to detect if and when the media is ready!

Target is Media Player

Open Playlist

Open the first media source in the specified play list.

Target is Media Player

Open Playlist Index

Open a particular media source in the specified play list.

Target is Media Player

Open Source

Open the specified media source.

A return value of true indicates that the player will attempt to open the media, but it may fail to do so later for other reasons, i.e. if a connection to the media server timed out. Use the OnMediaOpened and OnMediaOpenFailed delegates to detect if and when the media is ready!

Target is Media Player

Open Source Latent

Open the specified media source with options using a latent action.

A result of true indicates that the player successfully completed all requested operations.

Target is Media Player

Open Source with Options

Open the specified media source with supplied options applied.

A return value of true indicates that the player will attempt to open the media, but it may fail to do so later for other reasons, i.e. if a connection to the media server timed out. Use the OnMediaOpened and OnMediaOpenFailed delegates to detect if and when the media is ready!

Target is Media Player

Open Url

Opens the specified media URL.

A return value of true indicates that the player will attempt to open the media, but it may fail to do so later for other reasons, i.e. if a connection to the media server timed out. Use the OnMediaOpened and OnMediaOpenFailed delegates to detect if and when the media is ready!

Target is Media Player

Pause

Pauses media playback.

This is the same as setting the playback rate to 0.0.

Target is Media Player

Play

Starts media playback.

This is the same as setting the playback rate to 1.0.

Target is Media Player

Play and Seek

Starts playback from the media opened event, but can be used elsewhere.

Target is Media Player

Previous

Open the previous item in the current play list.

The player will start playing the new media source if it was playing something previously, otherwise it will only open the media source.

Target is Media Player

Reopen

Reopens the currently opened media or play list.

Target is Media Player

Rewind

Rewinds the media to the beginning.

This is the same as seeking to zero time.

Target is Media Player

Seek

Seeks to the specified playback time.

Target is Media Player

Select Track

Select the active track of the given type.

The selected track will use its currently active format. Active formats will be remembered on a per track basis. The first available format is active by

  1. To switch the track format, use SetTrackFormat instead.

Target is Media Player

Set Block on Time

Set the time on which to block.

If set, this player will block in TickInput or TickFetch until the video sample for the specified time are actually available.

Target is Media Player

Set Desired Player Name

Set the name of the desired native player.

Target is Media Player

Set Looping

Enables or disables playback looping.

Target is Media Player

Set Media Options

Sets the media options used by the player.

Target is Media Player

Set Native Volume

Set the volume on the native player if not mixing with Sound Wave asset.

The SetNativeVolume can be used to change the audio output volume at runtime. Note that not all media player plug-ins may support native audio output on all platforms.

Target is Media Player

Set Rate

Changes the media's playback rate.

Target is Media Player

Set Time Delay

Delay of the player's time.

This setting can be used to manually sync multiple sources. Set to 1 seconds, if you would like that Player to play 1 second behind his current time. If the value is too big, it is possible that the player would not hold that frame for that long.

Target is Media Player

Set Track Format

Set the format on the specified track.

Selecting the format will not switch to the specified track. To switch tracks, use SelectTrack instead. If the track is already selected, the format change will be applied immediately.

Target is Media Player

Set Video Track Frame Rate

Set the frame rate of the specified video track.

Target is Media Player

Set View Field

Set the field of view (only for 360 videos).

Target is Media Player

Set View Rotation

Set the view's rotation (only for 360 videos).

Target is Media Player

Supports Rate

Check whether the specified playback rate is supported.

Target is Media Player

Supports Scrubbing

Check whether the currently loaded media supports scrubbing.

Target is Media Player

Supports Seeking

Check whether the currently loaded media can jump to a certain position.

Target is Media Player