Player

Last Updated On 2021-07-16

Version 6MinSDK 7Tutorial Video

Multimedia component that plays audio and controls phone vibration. The name of a multimedia field is specified in the Source property, which can be set in the Designer or in the Blocks Editor. The length of time for a vibration is specified in the Blocks Editor in milliseconds (thousandths of a second).

For supported audio formats, see Android Supported Media Formats.

This component is best for long sound files, such as songs, while the Sound component is more efficient for short files, such as sound effects.

Properties

You can set the below properties in the UI part of the builder.

  • Loop - it's a boolean value which is set to false by default.
  • PlayOnlyInForeground - it's a boolean value which is set to false by default.
  • Source - it's a asset value which is set to blank by default.
  • Volume - it's a non negative float value which is set to 50 by default.

Block Properties

You can set the below blocks properties in the blocks section of the builder.

IsPlaying

Reports whether the media is playing


Loop

If true, the player will loop when it plays. Setting Loop while the player is playing will affect the current playing.


PlayOnlyInForeground

If true, the player will pause playing when leaving the current screen; if false (default option), the player continues playing whenever the current screen is displaying or not.


Source

Returns the path to the audio source


Volume

Sets the volume to a number between 0 and 100



Methods

You can set the below method blocks in the blocks section of the builder.

GetCurrentPosition

Method for GetCurrentPosition

GetDuration

Method for GetDuration

Pause

Suspends playing the media if it is playing.

SeekTo

Method for SeekTo

Start

Plays the media. If it was previously paused, the playing is resumed. If it was previously stopped, it starts from the beginning.

Stop

Stops playing the media and seeks to the beginning of the song.

Vibrate

Vibrates for specified number of milliseconds.


Events

You can set the below event blocks in the blocks section of the builder.

Completed

Indicates that the media has reached the end

OtherPlayerStarted

This event is signaled when another player has started (and the current player is playing or paused, but not stopped).

PlayerError

The PlayerError event is no longer used. Please use the Screen.ErrorOccurred event instead.