Merge pull request #15 from LePips/main

Sources/Entities/BaseItemDto.swift

@@ -270,7 +270,7 @@ public struct BaseItemDto: Codable, Identifiable {
     public var timerID: String?
     /// Gets or sets the trailer count.
     public var trailerCount: Int32?
-    /// Gets or sets the type.
+    /// The base item kind.
     public var type: BaseItemKind?
     /// Gets or sets the user data for this item based on the user it's being requested for.
     public var userData: UserItemDataDto?

Sources/Entities/ClientCapabilitiesDto.swift

@@ -12,17 +12,7 @@ import Foundation
 public struct ClientCapabilitiesDto: Codable {
     /// Gets or sets the app store url.
     public var appStoreURL: String?
-    /// A MediaBrowser.Model.Dlna.DeviceProfile represents a set of metadata which determines which content a certain device is able to play.
-    ///
-    /// <br />
-    ///
-    /// Specifically, it defines the supported <see cref="P:MediaBrowser.Model.Dlna.DeviceProfile.ContainerProfiles">containers</see> and
-    ///
-    /// <see cref="P:MediaBrowser.Model.Dlna.DeviceProfile.CodecProfiles">codecs</see> (video and/or audio, including codec profiles and levels)
-    ///
-    /// the device is able to direct play (without transcoding or remuxing),
-    ///
-    /// as well as which <see cref="P:MediaBrowser.Model.Dlna.DeviceProfile.TranscodingProfiles">containers/codecs to transcode to</see> in case it isn't.
+    /// Gets or sets the device profile.
     public var deviceProfile: DeviceProfile?
     /// Gets or sets the icon url.
     public var iconURL: String?

Sources/Entities/DisplayPreferencesDto.swift

@@ -26,15 +26,15 @@ public struct DisplayPreferencesDto: Codable, Identifiable {
     public var isRememberIndexing: Bool?
     /// Gets or sets a value indicating whether [remember sorting].
     public var isRememberSorting: Bool?
-    /// Gets or sets the scroll direction.
+    /// An enum representing the axis that should be scrolled.
     public var scrollDirection: ScrollDirection?
     /// Gets or sets a value indicating whether to show backdrops on this item.
     public var isShowBackdrop: Bool?
     /// Gets or sets a value indicating whether [show sidebar].
     public var isShowSidebar: Bool?
     /// Gets or sets the sort by.
     public var sortBy: String?
-    /// Gets or sets the sort order.
+    /// An enum representing the sorting order.
     public var sortOrder: SortOrder?
     /// Gets or sets the type of the view.
     public var viewType: String?

Sources/Entities/MediaStreamType.swift

@@ -14,4 +14,5 @@ public enum MediaStreamType: String, Codable, CaseIterable {
     case video = "Video"
     case subtitle = "Subtitle"
     case embeddedImage = "EmbeddedImage"
+    case data = "Data"
 }

Sources/Entities/OpenLiveStreamDto.swift

@@ -12,17 +12,7 @@ import Foundation
 public struct OpenLiveStreamDto: Codable {
     /// Gets or sets the audio stream index.
     public var audioStreamIndex: Int32?
-    /// A MediaBrowser.Model.Dlna.DeviceProfile represents a set of metadata which determines which content a certain device is able to play.
-    ///
-    /// <br />
-    ///
-    /// Specifically, it defines the supported <see cref="P:MediaBrowser.Model.Dlna.DeviceProfile.ContainerProfiles">containers</see> and
-    ///
-    /// <see cref="P:MediaBrowser.Model.Dlna.DeviceProfile.CodecProfiles">codecs</see> (video and/or audio, including codec profiles and levels)
-    ///
-    /// the device is able to direct play (without transcoding or remuxing),
-    ///
-    /// as well as which <see cref="P:MediaBrowser.Model.Dlna.DeviceProfile.TranscodingProfiles">containers/codecs to transcode to</see> in case it isn't.
+    /// Gets or sets the device profile.
     public var deviceProfile: DeviceProfile?
     /// Gets or sets the device play protocols.
     public var directPlayProtocols: [MediaProtocol]?

Sources/Entities/PlaybackInfoDto.swift

@@ -18,17 +18,7 @@ public struct PlaybackInfoDto: Codable {
     public var audioStreamIndex: Int32?
     /// Gets or sets a value indicating whether to auto open the live stream.
     public var isAutoOpenLiveStream: Bool?
-    /// A MediaBrowser.Model.Dlna.DeviceProfile represents a set of metadata which determines which content a certain device is able to play.
-    ///
-    /// <br />
-    ///
-    /// Specifically, it defines the supported <see cref="P:MediaBrowser.Model.Dlna.DeviceProfile.ContainerProfiles">containers</see> and
-    ///
-    /// <see cref="P:MediaBrowser.Model.Dlna.DeviceProfile.CodecProfiles">codecs</see> (video and/or audio, including codec profiles and levels)
-    ///
-    /// the device is able to direct play (without transcoding or remuxing),
-    ///
-    /// as well as which <see cref="P:MediaBrowser.Model.Dlna.DeviceProfile.TranscodingProfiles">containers/codecs to transcode to</see> in case it isn't.
+    /// Gets or sets the device profile.
     public var deviceProfile: DeviceProfile?
     /// Gets or sets a value indicating whether to enable direct play.
     public var enableDirectPlay: Bool?

Sources/Entities/QueueRequestDto.swift

@@ -12,7 +12,7 @@ import Foundation
 public struct QueueRequestDto: Codable {
     /// Gets or sets the items to enqueue.
     public var itemIDs: [String]?
-    /// Enum GroupQueueMode.
+    /// Gets or sets the mode in which to add the new items.
     public var mode: GroupQueueMode?
 
     public init(itemIDs: [String]? = nil, mode: GroupQueueMode? = nil) {

Sources/Entities/SessionInfo.swift

@@ -33,9 +33,7 @@ public struct SessionInfo: Codable, Identifiable {
     public var lastActivityDate: Date?
     /// Gets or sets the last playback check in.
     public var lastPlaybackCheckIn: Date?
-    /// This is strictly used as a data transfer object from the api layer.
-    ///
-    /// This holds information about a BaseItem in a format that is convenient for the client.
+    /// Gets or sets the now playing item.
     public var nowPlayingItem: BaseItemDto?
     public var nowPlayingQueue: [QueueItem]?
     public var nowPlayingQueueFullItems: [BaseItemDto]?

Sources/Entities/SetRepeatModeRequestDto.swift

@@ -10,7 +10,7 @@ import Foundation
 
 /// Class SetRepeatModeRequestDto.
 public struct SetRepeatModeRequestDto: Codable {
-    /// Enum GroupRepeatMode.
+    /// Gets or sets the repeat mode.
     public var mode: GroupRepeatMode?
 
     public init(mode: GroupRepeatMode? = nil) {

Sources/Entities/SetShuffleModeRequestDto.swift

@@ -10,7 +10,7 @@ import Foundation
 
 /// Class SetShuffleModeRequestDto.
 public struct SetShuffleModeRequestDto: Codable {
-    /// Enum GroupShuffleMode.
+    /// Gets or sets the shuffle mode.
     public var mode: GroupShuffleMode?
 
     public init(mode: GroupShuffleMode? = nil) {

Sources/Entities/TranscodeReason.swift

@@ -0,0 +1,37 @@
+//
+// jellyfin-sdk-swift is subject to the terms of the Mozilla Public
+// License, v2.0. If a copy of the MPL was not distributed with this
+// file, you can obtain one at https://mozilla.org/MPL/2.0/.
+//
+// Copyright (c) 2022 Jellyfin & Jellyfin Contributors
+//
+
+import Foundation
+
+public enum TranscodeReason: String, Codable, CaseIterable {
+    case containerNotSupported = "ContainerNotSupported"
+    case videoCodecNotSupported = "VideoCodecNotSupported"
+    case audioCodecNotSupported = "AudioCodecNotSupported"
+    case subtitleCodecNotSupported = "SubtitleCodecNotSupported"
+    case audioIsExternal = "AudioIsExternal"
+    case secondaryAudioNotSupported = "SecondaryAudioNotSupported"
+    case videoProfileNotSupported = "VideoProfileNotSupported"
+    case videoLevelNotSupported = "VideoLevelNotSupported"
+    case videoResolutionNotSupported = "VideoResolutionNotSupported"
+    case videoBitDepthNotSupported = "VideoBitDepthNotSupported"
+    case videoFramerateNotSupported = "VideoFramerateNotSupported"
+    case refFramesNotSupported = "RefFramesNotSupported"
+    case anamorphicVideoNotSupported = "AnamorphicVideoNotSupported"
+    case interlacedVideoNotSupported = "InterlacedVideoNotSupported"
+    case audioChannelsNotSupported = "AudioChannelsNotSupported"
+    case audioProfileNotSupported = "AudioProfileNotSupported"
+    case audioSampleRateNotSupported = "AudioSampleRateNotSupported"
+    case audioBitDepthNotSupported = "AudioBitDepthNotSupported"
+    case containerBitrateExceedsLimit = "ContainerBitrateExceedsLimit"
+    case videoBitrateNotSupported = "VideoBitrateNotSupported"
+    case audioBitrateNotSupported = "AudioBitrateNotSupported"
+    case unknownVideoStreamInfo = "UnknownVideoStreamInfo"
+    case unknownAudioStreamInfo = "UnknownAudioStreamInfo"
+    case directPlayError = "DirectPlayError"
+    case videoRangeTypeNotSupported = "VideoRangeTypeNotSupported"
+}

Sources/Entities/TranscodingInfo.swift

@@ -19,38 +19,10 @@ public struct TranscodingInfo: Codable {
     public var height: Int32?
     public var isAudioDirect: Bool?
     public var isVideoDirect: Bool?
-    public var transcodeReasons: TranscodeReasons?
+    public var transcodeReasons: [TranscodeReason]?
     public var videoCodec: String?
     public var width: Int32?
 
-    public enum TranscodeReasons: String, Codable, CaseIterable {
-        case containerNotSupported = "ContainerNotSupported"
-        case videoCodecNotSupported = "VideoCodecNotSupported"
-        case audioCodecNotSupported = "AudioCodecNotSupported"
-        case subtitleCodecNotSupported = "SubtitleCodecNotSupported"
-        case audioIsExternal = "AudioIsExternal"
-        case secondaryAudioNotSupported = "SecondaryAudioNotSupported"
-        case videoProfileNotSupported = "VideoProfileNotSupported"
-        case videoLevelNotSupported = "VideoLevelNotSupported"
-        case videoResolutionNotSupported = "VideoResolutionNotSupported"
-        case videoBitDepthNotSupported = "VideoBitDepthNotSupported"
-        case videoFramerateNotSupported = "VideoFramerateNotSupported"
-        case refFramesNotSupported = "RefFramesNotSupported"
-        case anamorphicVideoNotSupported = "AnamorphicVideoNotSupported"
-        case interlacedVideoNotSupported = "InterlacedVideoNotSupported"
-        case audioChannelsNotSupported = "AudioChannelsNotSupported"
-        case audioProfileNotSupported = "AudioProfileNotSupported"
-        case audioSampleRateNotSupported = "AudioSampleRateNotSupported"
-        case audioBitDepthNotSupported = "AudioBitDepthNotSupported"
-        case containerBitrateExceedsLimit = "ContainerBitrateExceedsLimit"
-        case videoBitrateNotSupported = "VideoBitrateNotSupported"
-        case audioBitrateNotSupported = "AudioBitrateNotSupported"
-        case unknownVideoStreamInfo = "UnknownVideoStreamInfo"
-        case unknownAudioStreamInfo = "UnknownAudioStreamInfo"
-        case directPlayError = "DirectPlayError"
-        case videoRangeTypeNotSupported = "VideoRangeTypeNotSupported"
-    }
-
     public init(
         audioChannels: Int32? = nil,
         audioCodec: String? = nil,
@@ -62,7 +34,7 @@ public struct TranscodingInfo: Codable {
         height: Int32? = nil,
         isAudioDirect: Bool? = nil,
         isVideoDirect: Bool? = nil,
-        transcodeReasons: TranscodeReasons? = nil,
+        transcodeReasons: [TranscodeReason]? = nil,
         videoCodec: String? = nil,
         width: Int32? = nil
     ) {
@@ -93,7 +65,7 @@ public struct TranscodingInfo: Codable {
         self.height = try values.decodeIfPresent(Int32.self, forKey: "Height")
         self.isAudioDirect = try values.decodeIfPresent(Bool.self, forKey: "IsAudioDirect")
         self.isVideoDirect = try values.decodeIfPresent(Bool.self, forKey: "IsVideoDirect")
-        self.transcodeReasons = try values.decodeIfPresent(TranscodeReasons.self, forKey: "TranscodeReasons")
+        self.transcodeReasons = try values.decodeIfPresent([TranscodeReason].self, forKey: "TranscodeReasons")
         self.videoCodec = try values.decodeIfPresent(String.self, forKey: "VideoCodec")
         self.width = try values.decodeIfPresent(Int32.self, forKey: "Width")
     }

Sources/Entities/UserPolicy.swift

@@ -52,7 +52,7 @@ public struct UserPolicy: Codable {
     public var maxParentalRating: Int32?
     public var passwordResetProviderID: String?
     public var remoteClientBitrateLimit: Int32?
-    /// Gets or sets a value indicating what SyncPlay features the user can access.
+    /// Enum SyncPlayUserAccessType.
     public var syncPlayAccess: SyncPlayUserAccessType?
 
     public init(