GetAVPlayerAttribute

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 version

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) 4 (Embedded 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) 17 (InternalChangeZoom) 18 (InternalChangeVolume) 19 (InternalChangePIP) 20 (InternalChangeExternalPlayback)	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 or iPadOS 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`	0 Video is paused (except for Picture in Picture) and audio continues to play when FileMaker Go moves to the background. 1 Both audio and video are paused when FileMaker Go moves to the background. 2 Both audio and video continue to play when FileMaker Go moves to the background.	number
`zoom`	Indicates how the video is displayed: 0 (Fit) The aspect ratio is preserved, and the video is scaled to fit within the playback area. 1 (Fill) The aspect ratio is preserved, and the video is scaled to fill the playback area. 2 (Stretch) The video is stretched to fill the playback area, but the aspect ratio is not preserved. 3 (Fit Only) Users are not allowed to change the zoom setting to Fill or Stretch. 4 (Fill Only) Users are not allowed to change the zoom setting to Fit or Stretch. 5 (Stretch Only) Users are not allowed to change the zoom setting to Fit or Fill.	number
`volume`	Indicates the volume level for the audio.	number
`pictureInPicture`	Specifies whether the video is displayed as Picture in Picture: 0 (Not Available) 1 (Not Active) 2 (Active)	number
`externalPlayback`	Specifies whether a video is played on an external device, such as Apple TV via AirPlay: 0 (Not Available) 1 (Not Active) 2 (Active)	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.

Copy

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.