Skip to content

Commit

Permalink
docs(api): mark Ti.Media.Sound.setLooping and setPaused as deprecated
Browse files Browse the repository at this point in the history
  • Loading branch information
sgtcoolguy committed Feb 10, 2021
1 parent 6904e78 commit e6a39cd
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions apidoc/Titanium/Media/Sound.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ methods:
- name: looping
summary: New value for the `looping` property.
type: Boolean
deprecated:
since: "10.0.0"
notes: Set the value of the [looping](Titanium.Media.Sound.looping) property directly.

- name: setPaused
summary: Sets the value of the [paused](Titanium.Media.Sound.paused) property.
Expand All @@ -68,6 +71,11 @@ methods:
summary: Pass `true` to pause the current playback temporarily, `false` to unpause it.
type: Boolean
platforms: [iphone, ipad, macos]
deprecated:
since: "10.0.0"
notes: |
It is preferable to use the [pause](Titanium.Media.Sound.pause) and
[play](Titanium.Media.Sound.play) methods instead.
- name: stop
summary: Stops playing the audio and resets the playback position to the beginning of the clip.
Expand Down

0 comments on commit e6a39cd

Please sign in to comment.