GetAVPlayerAttribute

Purpose

Returns the setting of the specified attribute for the audio, video, or image file in a container field.

Format

GetAVPlayerAttribute(attributeName)

Parameters

attributeName - the name of a supported attribute (see below).

Data type returned

text, number

Originated in

FileMaker Pro 14.0

Description

This function is used in FileMaker Go. If this function is called when the media file is playing or is paused, it returns a value for the file’s current playback state. If the function is called when no media is playing, it returns a value for the state of the media file most recently played. If the function is called when no media file has been played, it returns an empty string or 0.

Attributes


Attribute	Returns	Data type returned
all	All the attributes and their values.	text
sourceType	The source type used for audio and video files: 0 (None) 1 (URL) 2 (Field) 3 (Layout object) 4 (Active object)	number
source	The URL, field name, or layout object name. If sourceType is 4 (active object), then source returns an empty string.	text
playbackState	A number representing the state of the media playback: 0 (Stopped) 1 (Playing) 2 (Paused)	number
presentation	The method used to display the media: 0 (Embedded) 1 (Full Screen) 2 (Full Screen Only) 3 (Audio Only)	number
position	The position (in seconds) currently playing in the media.	number
startOffset	The starting position of the playback (in seconds).	number
endOffset	The end position of the playback (in seconds); returns 0 if playing to the end of the media.	number
duration	The length of time (in seconds) that the audio or video file will play.	number
triggerEvent	Indicates why the last OnObjectAVPlayerChange or OnFileAVPlayerChange script triggers were activated: 0 (Internal) 1 (Script) 2 (Remote)	number
triggerEventDetail	Provides information about the event that activated the last OnObjectAVPlayerChange or OnFileAVPlayerChange script trigger: 0 (Unknown) 1 (RemotePlayMedia) 2 (RemotePause) 3 (RemoteTogglePlayPause) 4 (RemotePlayNext) 5 (RemotePlayPrevious) 6 (RemoteSeek) 7 (RemoteStop) 8 (ScriptPlayMedia) 9 (ScriptChangePresentation) 10 (ScriptTogglePlayPause) 11 (ScriptStop) 12 (ScriptChangeSetting) 13 (InternalTogglePlayPause) 14 (InternalChangePresentation) 15 (InternalSeek) 16 (InternalStop)	number
sequence	Indicates which media file should be played next: 0 (None) -1 (Go to previous) +1 (Go to next)	number
result	0 if playback ends successfully; returns 1 if playback ends due to an error.	number
hideControls	1 (Yes) if the playback controls are hidden; otherwise returns 0 (No).	number
disableInteraction	1 (Yes) if users cannot interact with the playback; otherwise returns 0 (No).	number
disableExternalControls	1 (Yes) if the iOS playback controls on the lock screen or on the control panel are disabled when the media is playing or is paused; otherwise, returns 0 (No).	number
pauseInBackground	1 (Yes) if the audio is paused when FileMaker Go is moved to the background; otherwise returns 0 (No).	number
imageSourceType	The source type used for images: 0 (None) 1 (URL) 2 (Field) 3 (Layout object) 4 (Active object)	number
imageSource	The URL, field name, or layout object name for images.	text
imageDuration	The length of time (in seconds) that the images should be displayed.	number

Example 1

Stops playing a media file if it is currently playing.

If [GetAVPlayerAttribute("playbackState") = 1
AVPlayer Set Playback State [Stopped]
End If

Example 2

Checks the duration of a media file and displays a message if it is longer than 30 minutes.

If [GetAVPlayerAttribute("duration") > 1800
Show Custom Dialog ["Exceeds Maximum Duration"; "The current video is longer than 30 minutes."]
Else
AVPlayer Play [Field:Library::Video]
End If

Example 3

Plays the media file in full screen for iPhone, and embedded for iPad.

If [Get(Device) = 3 //iPad]
AVPlayer Play [Object: "Container"; Presentation: Start Embedded]
Else If [Get(Device) = 4 //iPhone]
AVPlayer Play [Object: "Container"; Presentation: Start Full Screen]
End If