[TIMOB-5436] iOS: Expose System Sound Services #8396

kopiro · 2016-09-19T08:38:26Z

JIRA: https://jira.appcelerator.org/browse/TIMOB-5436

You can use this module to provide audible alerts.

This module differs from the Sound module because it honors the ringtone volume, not the Music volume.

Example:

Ti.Media.createAlert({url: '/sounds/test.wav' }).play();

hansemannn

First CR-cycle done, please address the review-comments.

hansemannn · 2016-09-19T21:40:03Z

apidoc/Titanium/Media/Alert.yml

+description: |
+    You can use this module to provide audible alerts. 
+
+    You can use it to play short (30 seconds or shorter) sounds. The interface does not provide level, positioning, looping, or timing control, and does not support simultaneous playback: You can play only one sound at a time. 


Watch out for proper line-breaks (see other API's), so the line does not get too long.

hansemannn · 2016-09-19T21:40:38Z

apidoc/Titanium/Media/Alert.yml

+    Use the <Titanium.Media.createAlert> method to create a `Alert` object.
+
+    Know more about [System Sound Services](https://developer.apple.com/reference/audiotoolbox/1657326-system_sound_services).
+


Remove the empty lines here, it's formatted as a paragraph by the docs-generator.

hansemannn · 2016-09-19T21:40:45Z

apidoc/Titanium/Media/Alert.yml

+    Know more about [System Sound Services](https://developer.apple.com/reference/audiotoolbox/1657326-system_sound_services).
+
+extends: Titanium.Proxy
+since: "5.5.0"


Change to 6.1.0

hansemannn · 2016-09-19T21:41:06Z

apidoc/Titanium/Media/Alert.yml

+    summary: Starting playing the alert.
+
+events:
+


No events? If not, remove it.

hansemannn · 2016-09-19T21:41:20Z

apidoc/Titanium/Media/Alert.yml

+platforms: [iphone, ipad]
+methods:
+  - name: play
+    summary: Starting playing the alert.


Language: Start playing the alert.

hansemannn · 2016-09-19T21:42:01Z

iphone/Classes/TiMediaAlertProxy.h

@@ -0,0 +1,24 @@
+/**
+ * Appcelerator Titanium Mobile
+ * Copyright (c) 2009-2010 by Appcelerator, Inc. All Rights Reserved.


hansemannn · 2016-09-19T21:42:20Z

apidoc/Titanium/Media/Alert.yml

+    example: |
+        Simple example of playing a WAVE file from the Resources directory.
+
+            var player = Ti.Media.createAlert({url:"Alert.wav"});


Use alert.wav to be more handy in naming-conventions.

hansemannn · 2016-09-19T21:43:18Z

iphone/Classes/TiMediaAlertProxy.h

+    SystemSoundID sound;
+}
+
+@property (nonatomic,readonly) NSURL *url;


Do we need this as a property as well? Better make a usual getter -(NSURL*)url where you create the url instead of just returning it.

Not understanding this.

hansemannn · 2016-09-19T21:44:18Z

iphone/Classes/TiMediaAlertProxy.m

+        }
+    } else if ([url_ isKindOfClass:[TiBlob class]]) {
+        TiBlob *blob = (TiBlob*)url_;
+        if ([blob type]==TiBlobTypeFile){


Format: if ([blob type] == TiBlobTypeFile) {

hansemannn · 2016-09-19T21:45:53Z

iphone/Classes/TiMediaAlertProxy.m

+
+-(void)play:(id)args
+{
+    if (url == nil) return;


Use -(void)play:(id)unused

[TIMOB-5436] Refactor class

sgtcoolguy · 2016-10-31T15:06:11Z

ping @kopiro @hansemannn What is left over to get this merged?

kopiro · 2016-10-31T15:07:07Z

Nothing for me, tested and worked after @hansemannn PR

hansemannn · 2016-10-31T16:15:18Z

CR + FT passed, PR approved!

hansemannn · 2016-10-31T16:17:26Z

We may also want unit-tests to ensure the integrity of the url property and it's state. @kopiro can you do that? Quoting @sgtcoolguy's good tutorial here:

@chmiiller regarding Hans' comment about our unit tests. We maintain a test suite now that we use against PRs. The suite itself is at https://github.com/appcelerator/titanium-mobile-mocha-suite

In particular, it'd be good to add a unit test for Ti.UI.Label.setMaxLines in https://github.com/appcelerator/titanium-mobile-mocha-suite/blob/master/Resources/ti.ui.label.test.js

To do so, clone that repo down locally. Copy titanium-mobile-mocha-suite/Resources/ti.ui.label.test.js to titanium_mobile/tests/Resources/ti.ui.label.test.js and then edit it to add a test for maxLines. (Anything in the titanium_mobile/tests folder acts as an "override" for the test suite. So you could also cheat and copy the app.js and comment out all the other suites other than ti.ui.label.test.)

You can run the test suite with that change locally by doing:
cd titanium_mobile/build
npm install
node scons.js cleanbuild ios # builds and installs ios-only SDK as 6.1.0 in your system
node scons.js test iOS # runs the unit tests against iOS

Flavio De Stefano added 2 commits September 19, 2016 10:36

Added Alert Proxy

90854ee

Added docs for Titanium.Media.Alert

6df2e42

kopiro changed the title ~~Expose iOS System Sound Services~~ [TIMOB-5436] Expose iOS System Sound Services Sep 19, 2016

hansemannn reviewed Sep 19, 2016

View reviewed changes

hansemannn changed the title ~~[TIMOB-5436] Expose iOS System Sound Services~~ [TIMOB-5436] iOS: Expose System Sound Services Sep 19, 2016

hansemannn added ios community 🔥 labels Sep 19, 2016

Flavio De Stefano and others added 3 commits September 20, 2016 10:02

Addressing minor issues

2086b3f

[TIMOB-5436] Refactor class

f804a8f

Merge pull request #1 from hansemannn/PR-TIMOB-5436

8d27ac1

[TIMOB-5436] Refactor class

sgtcoolguy added this to the 6.1.0 milestone Oct 31, 2016

hansemannn merged commit e5d2679 into tidev:master Oct 31, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TIMOB-5436] iOS: Expose System Sound Services #8396

[TIMOB-5436] iOS: Expose System Sound Services #8396

kopiro commented Sep 19, 2016

hansemannn left a comment

hansemannn Sep 19, 2016

hansemannn Sep 19, 2016

hansemannn Sep 19, 2016

hansemannn Sep 19, 2016

hansemannn Sep 19, 2016

hansemannn Sep 19, 2016

hansemannn Sep 19, 2016

hansemannn Sep 19, 2016

kopiro Sep 20, 2016

hansemannn Sep 19, 2016 •

edited

hansemannn Sep 19, 2016

sgtcoolguy commented Oct 31, 2016

kopiro commented Oct 31, 2016

hansemannn commented Oct 31, 2016

hansemannn commented Oct 31, 2016

		Use the <Titanium.Media.createAlert> method to create a `Alert` object.

		Know more about [System Sound Services](https://developer.apple.com/reference/audiotoolbox/1657326-system_sound_services).

[TIMOB-5436] iOS: Expose System Sound Services #8396

[TIMOB-5436] iOS: Expose System Sound Services #8396

Conversation

kopiro commented Sep 19, 2016

hansemannn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hansemannn Sep 19, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sgtcoolguy commented Oct 31, 2016

kopiro commented Oct 31, 2016

hansemannn commented Oct 31, 2016

hansemannn commented Oct 31, 2016

hansemannn Sep 19, 2016 •

edited