Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TIDOC-2435] Adjust live photo docs #7786

Merged
merged 2 commits into from
Feb 29, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 11 additions & 5 deletions apidoc/Titanium/Media/Media.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1526,8 +1526,10 @@ properties:
default: false
- name: mediaTypes
summary: |
Array of media type constants to allow.
constants: Titanium.Media.MEDIA_TYPE_*
Array of media type constants to allow. Note: iOS 9.1 only allows to
select existing photos from the gallery, capturing new live photos is
not supported by the iOS public API, yet.
constants: [Titanium.Media.MEDIA_TYPE_PHOTO, Titanium.Media.MEDIA_TYPE_VIDEO]
type: Array<String>
default: Both photo and video allowed.
platforms: [iphone, ipad]
Expand Down Expand Up @@ -1611,7 +1613,8 @@ properties:
summary: Function to call if the user presses the cancel button.
type: Callback<FailureResponse>
- name: autohide
summary: Specifies if the photo gallery should be hidden automatically after the media
summary: |
Specifies if the photo gallery should be hidden automatically after the media
selection is completed.
type: Boolean
default: true
Expand All @@ -1627,10 +1630,13 @@ properties:
platforms: [iphone, ipad]
- name: mediaTypes
summary: |
Array of media type constants to allow.
Array of media type constants to allow. If you want to allow live photos with
<Titanium.Media.MEDIA_TYPE_LIVEPHOTO> on iOS 9.1 and later, you also need to specify
at least <Titanium.Media.MEDIA_TYPE_PHOTO> as a fallback. If you do not allow live
photos, they still can be selected, but will be represented as a normal photo (static).
type: Array<String>
constants: Titanium.Media.MEDIA_TYPE_*
default: Both photo and video allowed.
default: Only photo and video allowed.
platforms: [iphone, ipad]
- name: popoverView
summary: View to position the photo gallery popover on top of.
Expand Down
6 changes: 3 additions & 3 deletions apidoc/Titanium/UI/iOS/LivePhoto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ name: Titanium.UI.iOS.LivePhoto
summary: Abstract object representing a live photo used in <Titanium.UI.iOS.LivePhotoView>.
description: |
Use the <Titanium.UI.iOS.createLivePhotoView> to assign the `livePhoto` property.
You can receive a LivePhoto either by using [openPhotoGallery](Titanium.Media.openPhotoGallery)
to select a photo from the gallery or [showCamera](Titanium.Media.showCamera) to take
a new live photo.
You can receive a LivePhoto by using the [openPhotoGallery](Titanium.Media.openPhotoGallery) method.
iOS 9.1 only allows to select existing photos from the gallery, capturing new live photos is not
supported by the iOS public API, yet.

Note: This object only represents the proxy to hold a live photo and can not be created manually.

Expand Down
11 changes: 11 additions & 0 deletions apidoc/Titanium/UI/iOS/LivePhotoView.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,19 @@ extends: Titanium.UI.View
platforms: [iphone,ipad]
since: "5.2.0"
osver: {ios:{min: "9.1"}}
excludes:
events: [click,dblclick,doubletap,longpress,pinch,postlayout,singletap,swipe,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there no way to exclude all?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't find anything. The above example is the same as the Ti.UI.ListView uses for example.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

touchcancel,touchend,touchmove,touchstart,twofingertap]

properties:
- name: livePhoto
summary: The Live Photo displayed in the view.
description: |
You receive a new live photo object by selecting an existing photo from the photo gallery.
Note: iOS 9.1 only allows to select existing photos from the gallery, capturing new live
photos is not supported by the iOS public API, yet.
type: [Titanium.UI.iOS.LivePhoto]

- name: muted
summary: |
A Boolean value that determines whether the view plays the audio content of its Live Photo.
Expand Down