Skip to content

Commit

Permalink
docs(api): remove Ti.Media.VideoPlayer.contentURL, fix up platforms/r…
Browse files Browse the repository at this point in the history
…emoved on others
  • Loading branch information
sgtcoolguy committed Nov 2, 2020
1 parent 8a9a05e commit 47727bf
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 49 deletions.
64 changes: 32 additions & 32 deletions apidoc/Titanium/Media/Media.yml
Original file line number Diff line number Diff line change
Expand Up @@ -882,31 +882,31 @@ properties:
summary: Constant specifying that app is authorized to use camera. This is available on iOS7 and later.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]
since: "4.0.0"
osver: {ios: {min: "7.0"}}

- name: CAMERA_AUTHORIZATION_DENIED
summary: Constant specifying that app is denied usage of camera. This is available on iOS7 and later.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]
since: "4.0.0"
osver: {ios: {min: "7.0"}}

- name: CAMERA_AUTHORIZATION_RESTRICTED
summary: Constant specifying that app is restricted from using camera. This is available on iOS7 and later.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]
since: "4.0.0"
osver: {ios: {min: "7.0"}}

- name: CAMERA_AUTHORIZATION_UNKNOWN
summary: Constant specifying that app is not yet authorized to use camera. This is available on iOS7 and later.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]
since: "5.2.0"
osver: {ios: {min: "7.0"}}

Expand All @@ -925,7 +925,7 @@ properties:
type: String
permission: read-only
since: "5.2.0"
platforms: [iphone, ipad, macos]
exclude-platforms: [android]
osver: {ios: {min: "9.1"}}

- name: MEDIA_TYPE_VIDEO
Expand All @@ -937,171 +937,171 @@ properties:
summary: Music library media containing any type of content.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_MEDIA_TYPE_ANY_AUDIO
summary: Music library media containing any type of audio content.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_MEDIA_TYPE_AUDIOBOOK
summary: Music library media containing audiobook content.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_MEDIA_TYPE_MUSIC
summary: Music library media containing music content.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_MEDIA_TYPE_PODCAST
summary: Music library media containing podcast content.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_MEDIA_GROUP_TITLE
summary: Constant for grouping query results by title.
value: 0
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_MEDIA_GROUP_ALBUM
summary: Constant for grouping query results by album.
value: 1
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_MEDIA_GROUP_ARTIST
summary: Constant for grouping query results by artist.
value: 2
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_MEDIA_GROUP_ALBUM_ARTIST
summary: Constant for grouping query results by album and artist.
value: 3
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_MEDIA_GROUP_COMPOSER
summary: Constant for grouping query results by composer.
value: 4
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_MEDIA_GROUP_GENRE
summary: Constant for grouping query results by genre.
value: 5
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_MEDIA_GROUP_PLAYLIST
summary: Constant for grouping query results by playlist.
value: 6
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_MEDIA_GROUP_PODCAST_TITLE
summary: Constant for grouping query results by podcast title.
value: 7
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_REPEAT_ALL
summary: Constant for "Repeat All" setting.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_REPEAT_DEFAULT
summary: Constant for user's default repeat setting.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_REPEAT_NONE
summary: Constant for "No Repeat" setting.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_REPEAT_ONE
summary: Constant for "Repeat one item" setting.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_SHUFFLE_ALBUMS
summary: Constant for shuffling complete albums setting.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_SHUFFLE_DEFAULT
summary: Constant for user's default shuffle setting.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_SHUFFLE_NONE
summary: Constant for "no shuffle" setting.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_SHUFFLE_SONGS
summary: Constant for shuffling songs setting.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_STATE_INTERRUPTED
summary: Constant for interrupted state.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_STATE_PAUSED
summary: Constant for paused state.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_STATE_PLAYING
summary: Constant for playing state.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_STATE_SEEK_BACKWARD
summary: Constant for backward seek state.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_STATE_SEEK_FORWARD
summary: Constant for forward seek state.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: MUSIC_PLAYER_STATE_STOPPED
summary: Constant for stopped state.
type: Number
permission: read-only
platforms: [iphone, ipad, macos]
exclude-platforms: [android]

- name: NO_CAMERA
summary: Constant for media no camera error.
Expand Down
24 changes: 7 additions & 17 deletions apidoc/Titanium/Media/VideoPlayer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -509,15 +509,6 @@ properties:
platforms: [iphone, ipad, macos]
type: Titanium.UI.View

- name: contentURL
summary: URL of the media to play.
exclude-platforms: [macos]
deprecated:
since: "1.4.0"
removed: "3.0.0"
notes: Use [Titanium.Media.VideoPlayer.url](Titanium.Media.VideoPlayer.url) instead.
type: String

- name: currentPlaybackTime
summary: Current playback time of the current movie in milliseconds.
type: Number
Expand Down Expand Up @@ -545,19 +536,15 @@ properties:
default: 0

- name: fullscreen
exclude-platforms: [macos]
platforms: [android]
deprecated:
since: "7.0.0"
notes: This method has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.
removed: "7.0.0"
notes: This property has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.
summary: |
Determines if the movie is presented in the entire screen (obscuring all other application content).
description: |
Note that this must be set at different times on different platforms:
On iOS, setting this property to `true` before the movie player's view is visible
has no effect.
On Android, this property must be set at creation time. For example:
``` js
Expand All @@ -566,7 +553,10 @@ properties:
On Android, setting this value to `true` means that the video will have its own Android Activity
rather than being embedded as a view.
This property was removed on iOS in SDK 7.0.0
type: Boolean
permission: creation-only
default: false

- name: initialPlaybackTime
Expand All @@ -584,7 +574,7 @@ properties:
permission: read-only

- name: media
summary: Media object to play, as either a `File`, a `Blob`, or a URL.
summary: Media object to play, as either a `Ti.Filesystem.File`, a `Ti.Blob`, or an URL `String`.
platforms: [iphone, ipad, macos]
type: [Titanium.Blob, Titanium.Filesystem.File, String]
permission: write-only
Expand Down Expand Up @@ -663,7 +653,7 @@ properties:
summary: Whether or not the receiver allows Picture in Picture playback.
platforms: [iphone, ipad, macos]
type: Boolean
default: true
default: false
osver: {ios: {min: "9.0"}}

- name: playableDuration
Expand Down

0 comments on commit 47727bf

Please sign in to comment.