Skip to content
This repository was archived by the owner on Sep 7, 2021. It is now read-only.

Commit 084bcbc

Browse files
committed
[[ Player ]] Update mobileControl dictionary entries after switch to AVKit
This patch updates the dictionary entries of mobileControlDo, mobileControlSet, and mobileControlGet to indicate removal of supported actions & properties from the iOS mobile player control.
1 parent 1d20d5c commit 084bcbc

File tree

3 files changed

+40
-58
lines changed

3 files changed

+40
-58
lines changed

docs/dictionary/command/mobileControlDo.lcdoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,12 @@ momentarily.
8282
- "stop": Stop playing the content of the player.
8383
- "prepareToPlay" (iOS Only): Make the content ready to play, but
8484
don't actually commence playback.
85-
- "begin seeking forward" (iOS Only): Start seeking forward through
86-
the content of the player.
87-
- "begin seeking backward" (iOS Only): Start seeking backward through
88-
the content of the player.
89-
- "end seeking" (iOS Only): Stop seeking through the content of the
90-
player.
85+
- ~~"begin seeking forward" (iOS Only): Start seeking forward through
86+
the content of the player.~~ *Note*: removed in LiveCode 9.6
87+
- ~~"begin seeking backward" (iOS Only): Start seeking backward through
88+
the content of the player.~~ *Note*: removed in LiveCode 9.6
89+
- ~~"end seeking" (iOS Only): Stop seeking through the content of the
90+
player.~~ *Note*: removed in LiveCode 9.6
9191
- "snapshot" | "snapshot exactly", *time*, [ *maxWidth*, *maxHeight* ]
9292
(iOS Only): Take a snapshot of the movie at time milliseconds from the
9393
beginning. If the 'exactly' form is specified the frame produced is

docs/dictionary/command/mobileControlSet.lcdoc

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ filename of the player automatically 'prepares' the movie for playback.
203203
the content. This is a boolean value.
204204

205205
- "currentTime": The current position of the playhead, measured in
206-
milliseconds (maps to the native currentPlaybackTime property). This is
206+
milliseconds. This is
207207
an integer value.
208208

209209
- "looping": Determines whether the playback of the movie should loop
@@ -217,38 +217,33 @@ should preserve its aspect ratio when scaled to fit within the control's
217217
bounds. This is a boolean value.
218218

219219
- "useApplicationAudioSession" (iOS Only): Determines whether the movie
220-
uses a system-supplied audio session or not (maps to the native
221-
useApplicationAudioSession property). This is a boolean value.
220+
uses a system-supplied audio session or not. This is a boolean value.
222221

223-
- "shouldAutoplay" (iOS Only): Determines whether the playback of
222+
- ~~"shouldAutoplay" (iOS Only): Determines whether the playback of
224223
network-based content begins automatically when there is enough buffered
225-
data to ensure uninterrupted playback (maps to the native shouldAutoplay
226-
property). This is a boolean value.
224+
data to ensure uninterrupted playback. This is a boolean value.~~
225+
*Note*: removed in LiveCode 9.6
227226

228227
- "allowsAirPlay" (iOS Only): Determines whether a control should be
229228
presented to allow the user to choose AirPlay-enabled hardware for
230-
playback (maps to the native allowsAirPlay property). This is a boolean
231-
value. This property is only supported on iOS 4.3 and later.
229+
playback. This is a boolean value. This property is only supported
230+
on iOS 4.3 and later.
232231

233232
- "playableDuration" (iOS Only): The amount of currently playable
234-
content, measured in milliseconds (maps to the native playableDuration
235-
property). This is an integer value.
233+
content, measured in milliseconds. This is an integer value.
236234

237235
- "startTime" (iOS Only): The position at which playback should start,
238-
measured in milliseconds (maps to the native initialPlaybackTime
239-
property). This is an integer value.
236+
measured in milliseconds. This is an integer value.
240237

241238
- "endTime" (iOS Only): The position at which playback should end,
242-
measured in milliseconds (maps to the native endPlaybackTime property).
243-
This is an integer value. Set to -1 to make the video to play to the
244-
end.
245-
246-
- "playRate" (iOS Only): The current playback rate for the player (maps
247-
to the native currentPlaybackRate property). This represents a
248-
multiplier for the default playback rate of the current content. A value
249-
of 0.0 indicates playback is stopped, while a value of 1.0 indicates
250-
normal speed. Positive values indicate forward playback, while negative
251-
values indicate reverse playback. This is a real value.
239+
measured in milliseconds. This is an integer value. Set to -1 to make
240+
the video to play to the end.
241+
242+
- "playRate" (iOS Only): The current playback rate for the player. This
243+
represents a multiplier for the default playback rate of the current
244+
content. A value of 0.0 indicates playback is stopped, while a value of
245+
1.0 indicates normal speed. Positive values indicate forward playback,
246+
while negative values indicate reverse playback. This is a real value.
252247

253248

254249
**Text Input Specific Properties**

docs/dictionary/function/mobileControlGet.lcdoc

Lines changed: 17 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -212,58 +212,46 @@ to play fullscreen.
212212
should preserve its aspect ratio when scaled to fit within the control's
213213
bounds.
214214

215-
- "useApplicationAudioSession" (iOS Only): returns true if the movie
216-
uses a system-supplied audio session or not (maps to the native
217-
useApplicationAudioSession property).
215+
- ~~"useApplicationAudioSession" (iOS Only): returns true if the movie
216+
uses a system-supplied audio session or not.~~ *Note*: removed in LiveCode 9.6
218217

219218
- "shouldAutoplay" (iOS Only): returns true if the playback of
220219
network-based content begins automatically when there is enough buffered
221-
data to ensure uninterrupted playback (maps to the native shouldAutoplay
222-
property).
220+
data to ensure uninterrupted playback.
223221

224222
- "allowsAirPlay" (iOS Only): returns true if a control is presented to
225-
allow the user to choose AirPlay-enabled hardware for playback (maps to
226-
the native allowsAirPlay property). Note: This property is only
227-
supported on iOS 4.3 and later.
223+
allow the user to choose AirPlay-enabled hardware for playback. Note: This
224+
property is only supported on iOS 4.3 and later.
228225

229226
- "duration": returns the duration of a movie, measured in
230-
milliseconds (maps to the native duration property on iOS). This is an integer
231-
value.
227+
milliseconds. This is an integer value.
232228

233229
- "playableDuration": returns the amount of currently
234-
playable content, measured in milliseconds (maps to the native
235-
playableDuration property on iOS). This is an integer value.
230+
playable content, measured in milliseconds. This is an integer value.
236231

237232
- "startTime" (iOS Only): returns the position at which playback starts,
238-
measured in milliseconds (maps to the native initialPlaybackTime
239-
property). This is an integer value.
233+
measured in milliseconds. This is an integer value.
240234

241235
- "endTime" (iOS Only): returns the position at which playback ends,
242-
measured in milliseconds (maps to the native endPlaybackTime property).
243-
This is an integer value.
236+
measured in milliseconds. This is an integer value.
244237

245238
- "playRate" (iOS Only): returns the current playback rate for the
246-
player (maps to the native currentPlaybackRate property). This
247-
represents a multiplier for the default playback rate of the current
248-
content. A value of 0.0 indicates playback is stopped, while a value of
239+
player. This represents a multiplier for the default playback rate of the
240+
current content. A value of 0.0 indicates playback is stopped, while a value of
249241
1.0 indicates normal speed. Positive values indicate forward playback,
250242
while negative values indicate reverse playback. This is real value.
251243

252-
253-
- "loadState" (iOS Only): returns the network load state of the player
254-
(maps to the native loadStateproperty). This is a comma delimited list
255-
of zero or more of the following:
244+
- "loadState" (iOS Only): returns the network load state of the player. This is
245+
a comma delimited list of zero or more of the following:
256246
- "playable": enough data is available to start playing, but it may
257247
run out before playback finishes.
258248
- "playthrough": enough data has been buffered for playback to
259249
continue uninterrupted.
260250
- "stalled": buffer of data has stalled and playback may pause
261251
automatically if the player runs out of data.
262252

263-
264253
- "playbackState" (iOS Only): returns the current playback state of the
265-
player (maps to the native playbackState property). This is one of the
266-
following:
254+
player. This is one of the following:
267255
- "stopped": playback is stopped and commences from the
268256
beginning when started.
269257
- "playing": playback is current underway.
@@ -276,10 +264,9 @@ of the movie.
276264
- "seeking backward": the player is currently seeking towards the
277265
beginning of the movie.
278266

279-
280-
- "naturalSize" (iOS Only): The raw size of a video frame in pixels
281-
(maps to the native naturalSize property). This is a comma-separated
282-
list of two integers, the first is the width, the second is the height.
267+
- "naturalSize" (iOS Only): The raw size of a video frame in pixels.
268+
This is a comma-separated list of two integers, the first is the width,
269+
the second is the height.
283270

284271

285272
**Text Input Specific Properties**

0 commit comments

Comments
 (0)