summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLMediaServiceData.h
diff options
context:
space:
mode:
Diffstat (limited to 'SmartDeviceLink/SDLMediaServiceData.h')
-rw-r--r--SmartDeviceLink/SDLMediaServiceData.h19
1 files changed, 19 insertions, 0 deletions
diff --git a/SmartDeviceLink/SDLMediaServiceData.h b/SmartDeviceLink/SDLMediaServiceData.h
index 6df77c304..8b44a4aa9 100644
--- a/SmartDeviceLink/SDLMediaServiceData.h
+++ b/SmartDeviceLink/SDLMediaServiceData.h
@@ -19,6 +19,25 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLMediaServiceData : SDLRPCStruct
/**
+ * Convenience init
+ *
+ * @param mediaType The type of the currently playing or paused track
+ * @param mediaTitle The name of the current playing media
+ * @param mediaArtist The name of the current media artist
+ * @param mediaAlbum The name of the current media album
+ * @param playlistName The name of the playlist
+ * @param isExplicit Whether or not the content currently playing contains explicit content
+ * @param trackPlaybackProgress The current progress of the track
+ * @param trackPlaybackDuration The total duration of the track
+ * @param queuePlaybackProgess The current progress of the playback queue in seconds
+ * @param queuePlaybackDuration The total duration of the playback queue in seconds
+ * @param queueCurrentTrackNumber The current number (1 based) of the track in the playback queue
+ * @param queueTotalTrackCount The total number of tracks in the playback queue
+ * @return A SDLMediaServiceData object
+ */
+- (instancetype)initWithMediaType:(nullable SDLMediaType)mediaType mediaTitle:(nullable NSString *)mediaTitle mediaArtist:(nullable NSString *)mediaArtist mediaAlbum:(nullable NSString *)mediaAlbum playlistName:(nullable NSString *)playlistName isExplicit:(BOOL)isExplicit trackPlaybackProgress:(UInt32)trackPlaybackProgress trackPlaybackDuration:(UInt32)trackPlaybackDuration queuePlaybackProgess:(UInt32)queuePlaybackProgess queuePlaybackDuration:(UInt32)queuePlaybackDuration queueCurrentTrackNumber:(UInt32)queueCurrentTrackNumber queueTotalTrackCount:(UInt32)queueTotalTrackCount;
+
+/**
* The type of the currently playing or paused track.
*
* SDLMediaType, Optional