From fd1ac55730295d67d7b14409ffef21f50b04b392 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samuel=20De=CC=81fago?= Date: Fri, 28 Sep 2018 14:24:11 +0200 Subject: [PATCH 1/4] Bump version number --- SRGMediaPlayer.xcodeproj/project.pbxproj | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/SRGMediaPlayer.xcodeproj/project.pbxproj b/SRGMediaPlayer.xcodeproj/project.pbxproj index 662dbbab..ccb4c705 100644 --- a/SRGMediaPlayer.xcodeproj/project.pbxproj +++ b/SRGMediaPlayer.xcodeproj/project.pbxproj @@ -1289,7 +1289,7 @@ GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; IPHONEOS_DEPLOYMENT_TARGET = 9.0; - MARKETING_VERSION = 2.5.2; + MARKETING_VERSION = 2.5.3; ONLY_ACTIVE_ARCH = YES; SDKROOT = iphoneos; TARGETED_DEVICE_FAMILY = "1,2"; @@ -1426,7 +1426,7 @@ GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; IPHONEOS_DEPLOYMENT_TARGET = 9.0; - MARKETING_VERSION = 2.5.2; + MARKETING_VERSION = 2.5.3; SDKROOT = iphoneos; TARGETED_DEVICE_FAMILY = "1,2"; VALIDATE_PRODUCT = YES; @@ -1652,7 +1652,7 @@ GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; IPHONEOS_DEPLOYMENT_TARGET = 9.0; - MARKETING_VERSION = 2.5.2; + MARKETING_VERSION = 2.5.3; ONLY_ACTIVE_ARCH = YES; SDKROOT = iphoneos; TARGETED_DEVICE_FAMILY = "1,2"; @@ -1703,7 +1703,7 @@ GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; IPHONEOS_DEPLOYMENT_TARGET = 9.0; - MARKETING_VERSION = 2.5.2; + MARKETING_VERSION = 2.5.3; SDKROOT = iphoneos; TARGETED_DEVICE_FAMILY = "1,2"; VALIDATE_PRODUCT = YES; From 437054d08bedec6118a5446c377dba948d6e9fe2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samuel=20De=CC=81fago?= Date: Fri, 5 Oct 2018 10:07:10 +0200 Subject: [PATCH 2/4] Use consistent naming scheme --- .../outlets.jpg | Bin docs/{Getting-started.md => GETTING_STARTED.md} | 2 +- docs/{Migration-guide.md => MIGRATION_GUIDE.md} | 0 docs/README.md | 4 ++-- 4 files changed, 3 insertions(+), 3 deletions(-) rename docs/{Getting-started-images => GETTING_STARTED-images}/outlets.jpg (100%) rename docs/{Getting-started.md => GETTING_STARTED.md} (99%) rename docs/{Migration-guide.md => MIGRATION_GUIDE.md} (100%) diff --git a/docs/Getting-started-images/outlets.jpg b/docs/GETTING_STARTED-images/outlets.jpg similarity index 100% rename from docs/Getting-started-images/outlets.jpg rename to docs/GETTING_STARTED-images/outlets.jpg diff --git a/docs/Getting-started.md b/docs/GETTING_STARTED.md similarity index 99% rename from docs/Getting-started.md rename to docs/GETTING_STARTED.md index 2f51934a..a1bb4d76 100644 --- a/docs/Getting-started.md +++ b/docs/GETTING_STARTED.md @@ -38,7 +38,7 @@ The `SRGMediaPlayerViewController` class natively supports all kind of audio and Custom player layouts can be designed entirely in Interface Builder, whether you are using xibs or storyboards. You can create your custom player entirely in code if you want, but using Interface Builder is recommended. -![Connecting outlets](Getting-started-images/outlets.jpg) +![Connecting outlets](GETTING_STARTED-images/outlets.jpg) Start by adding a view controller to a storyboard file. Drop a custom object from the library and set its class to `SRGMediaPlayerController`. This controller object will manage playback of medias. diff --git a/docs/Migration-guide.md b/docs/MIGRATION_GUIDE.md similarity index 100% rename from docs/Migration-guide.md rename to docs/MIGRATION_GUIDE.md diff --git a/docs/README.md b/docs/README.md index 713af74d..36d382de 100644 --- a/docs/README.md +++ b/docs/README.md @@ -85,7 +85,7 @@ import SRGMediaPlayer ### Working with the library -To learn about how the library can be used, have a look at the [getting started guide](Getting-started.md). +To learn about how the library can be used, have a look at the [getting started guide](GETTING_STARTED.md). ### Logging @@ -122,7 +122,7 @@ To test what the library is capable of, run the associated demo. ## Migration from versions 1.x -For information about changes introduced with version 2 of the library, please read the [migration guide](Migration-guide.md). +For information about changes introduced with version 2 of the library, please read the [migration guide](MIGRATION_GUIDE.md). ## License From b10d4fed8978873c5c056aea0d4076d3fcdc78ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samuel=20De=CC=81fago?= Date: Wed, 10 Oct 2018 07:27:07 +0200 Subject: [PATCH 3/4] Update documentation for consistency --- .../Sources/Helpers/SRGMediaPlayerConstants.h | 26 ++++++++++++++----- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/Framework/Sources/Helpers/SRGMediaPlayerConstants.h b/Framework/Sources/Helpers/SRGMediaPlayerConstants.h index 9e9838b8..e50977f1 100644 --- a/Framework/Sources/Helpers/SRGMediaPlayerConstants.h +++ b/Framework/Sources/Helpers/SRGMediaPlayerConstants.h @@ -176,24 +176,36 @@ OBJC_EXTERN NSString * const SRGMediaPlayerErrorKey; */ OBJC_EXTERN NSString * const SRGMediaPlayerSeekTimeKey; // Key to access the time to which the seek is made, as an `NSValue` (wrapping a `CMTime` value). -// Information available for all segment-related notifications. +/** + * Information available for all segment-related notifications. + */ OBJC_EXTERN NSString * const SRGMediaPlayerSegmentKey; // The involved segment as an `id` object. -// Information available for `SRGMediaPlayerSegmentDidStartNotification` and `SRGMediaPlayerSegmentDidEndNotification`. +/** + * Information available for `SRGMediaPlayerSegmentDidStartNotification` and `SRGMediaPlayerSegmentDidEndNotification`. + */ OBJC_EXPORT NSString * const SRGMediaPlayerSelectedKey; // Key to an `NSNumber` wrapping a boolean, set to `YES` iff the segment was selected. -// Information available for `SRGMediaPlayerSegmentDidStartNotification`. +/** + * Information available for `SRGMediaPlayerSegmentDidStartNotification`. + */ OBJC_EXTERN NSString * const SRGMediaPlayerPreviousSegmentKey; // The previously played segment, if any, as an `id` object. -// Information available for `SRGMediaPlayerSegmentDidEndNotification`. +/** + * Information available for `SRGMediaPlayerSegmentDidEndNotification`. + */ OBJC_EXTERN NSString * const SRGMediaPlayerNextSegmentKey; // The segment which will be played next, if any, as an `id` object. OBJC_EXTERN NSString * const SRGMediaPlayerInterruptionKey; // Key to an `NSNumber` wrapping a boolean, set to `YES` iff the end notification results because segment playback was interrupted. -// Information available for `SRGMediaPlayerSegmentDidStartNotification`, `SRGMediaPlayerSegmentDidEndNotification` and `SRGMediaPlayerPlaybackStateDidChangeNotification`. +/** + * Information available for `SRGMediaPlayerSegmentDidStartNotification`, `SRGMediaPlayerSegmentDidEndNotification` and `SRGMediaPlayerPlaybackStateDidChangeNotification`. + */ OBJC_EXTERN NSString * const SRGMediaPlayerSelectionKey; // Key to an `NSNumber` wrapping a boolean, set to `YES` iff the notification results from a segment selection. -// Information available for all notifications, except `SRGMediaPlayerPictureInPictureStateDidChangeNotification` and `SRGMediaPlayerExternalPlaybackStateDidChangeNotification`. -// For `SRGMediaPlayerPlaybackStateDidChangeNotification` notifications, this key is only present when the player returns to idle, and provides the last known playback position. +/** + * Information available for all notifications, except `SRGMediaPlayerPictureInPictureStateDidChangeNotification` and `SRGMediaPlayerExternalPlaybackStateDidChangeNotification`. + * For `SRGMediaPlayerPlaybackStateDidChangeNotification` notifications, this key is only present when the player returns to idle, and provides the last known playback position. + */ OBJC_EXPORT NSString * const SRGMediaPlayerLastPlaybackTimeKey; // Key to an `NSValue` wrapping a `CMTime` specifying the last playback position before the event occurred. NS_ASSUME_NONNULL_END From 3c96ea2b9f68c7ae87b6e286516a126908b5273d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samuel=20De=CC=81fago?= Date: Wed, 10 Oct 2018 07:30:30 +0200 Subject: [PATCH 4/4] Fix typo --- Framework/Sources/Helpers/SRGMediaPlayerConstants.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Framework/Sources/Helpers/SRGMediaPlayerConstants.h b/Framework/Sources/Helpers/SRGMediaPlayerConstants.h index e50977f1..f6290747 100644 --- a/Framework/Sources/Helpers/SRGMediaPlayerConstants.h +++ b/Framework/Sources/Helpers/SRGMediaPlayerConstants.h @@ -139,7 +139,7 @@ OBJC_EXTERN NSString * const SRGMediaPlayerExternalPlaybackStateDidChangeNotific /** * Notification sent when the current segment changes. Use the keys available below to retrieve information from - * the notification `userInfo`dictionary. + * the notification `userInfo` dictionary. */ OBJC_EXTERN NSString * const SRGMediaPlayerSegmentDidStartNotification; // Notification sent when a segment starts. OBJC_EXTERN NSString * const SRGMediaPlayerSegmentDidEndNotification; // Notification sent when a segment ends.