kodi_client 0.6.3 → 0.6.4

data/lib/kodi_client/types/player/player_speed_type.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # player speed enum, -32 to 32
+      module PlayerSpeed
+        extend Extensions::Iterable
+
+        MINUS_32 = -32
+        MINUS_16 = -16
+        MINUS_8 = -8
+        MINUS_4 = -4
+        MINUS_2 = -2
+        MINUS_1 = -1
+        NEUTRAL = 0
+        PLUS_1 = 1
+        PLUS_2 = 2
+        PLUS_4 = 4
+        PLUS_8 = 8
+        PLUS_16 = 16
+        PLUS_32 = 32
+      end
+    end
+  end
+end

data/lib/kodi_client/types/player/player_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # player item
+      class Player
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :player_id, :player_type, :type, :name, :plays_audio, :plays_video
+
+        def initialize(player_id, player_type, type, name, plays_audio, plays_video)
+          @player_id = player_id
+          @player_type = player_type
+          @type = type
+          @name = name
+          @plays_audio = plays_audio
+          @plays_video = plays_video
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/player/player_type_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # Player.Type https://kodi.wiki/view/JSON-RPC_API/v12#Player.Type
+      module PlayerType
+        extend Extensions::Iterable
+
+        VIDEO = 'video'
+        AUDIO = 'audio'
+        PICTURE = 'picture'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/player/player_view_mode_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # return value for Player.GetViewMode
+      class PlayerViewMode
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :nonlinear_stretch, :pixel_ratio, :vertical_shift, :view_mode, :zoom
+
+        def initialize(nonlinear_stretch, pixel_ratio, vertical_shift, view_mode, zoom)
+          @nonlinear_stretch = nonlinear_stretch
+          @pixel_ratio = pixel_ratio
+          @vertical_shift = vertical_shift
+          @view_mode = view_mode
+          @zoom = zoom
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/player/player_visibility_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # player types
+      module PlayerVisibility
+        extend Extensions::Iterable
+
+        INTERNAL = 'internal'
+        EXTERNAL = 'external'
+        REMOTE = 'remote'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/player/property_name_type.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # Player.Property.Name https://kodi.wiki/view/JSON-RPC_API/v12#Player.Property.Name
+      module PropertyName
+        extend Extensions::Iterable
+
+        AUDIO_STREAMS = 'audiostreams'
+        CAN_CHANGE_SPEED = 'canchangespeed'
+        CAN_MOVE = 'canmove'
+        CAN_REPEAT = 'canrepeat'
+        CAN_ROTATE = 'canrotate'
+        CAN_SEEK = 'canseek'
+        CAN_SHUFFLE = 'canshuffle'
+        CAN_ZOOM = 'canzoom'
+        CURRENT_AUDIO_STREAM = 'currentaudiostream'
+        CURRENT_SUBTITLE = 'currentsubtitle'
+        CURRENT_VIDEO_STREAM = 'currentvideostream'
+        LIVE = 'live'
+        PARTY_MODE = 'partymode'
+        PERCENTAGE = 'percentage'
+        PLAYLIST_ID = 'playlistid'
+        POSITION = 'position'
+        REPEAT = 'repeat'
+        SHUFFLED = 'shuffled'
+        SPEED = 'speed'
+        SUBTITLE_ENABLED = 'subtitleenabled'
+        SUBTITLES = 'subtitles'
+        TIME = 'time'
+        TOTAL_TIME = 'totaltime'
+        TYPE = 'type'
+        VIDEO_STREAMS = 'videostreams'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/player/property_value_type.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # Player.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#Player.Property.Name
+      class PropertyValue
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :audio_streams, :cache_percentage, :can_change_speed, :can_move, :can_repeat, :can_rotate,
+                    :can_seek, :can_shuffle, :can_zoom, :current_audio_stream, :current_subtitle, :current_video_stream,
+                    :live, :party_mode, :percentage, :playlist_id, :position, :repeat, :shuffled, :speed,
+                    :subtitle_enabled, :subtitles, :time, :total_time, :type, :video_streams
+
+        type_mapping ['audiostreams', AudioStream, true], ['currentaudiostream', AudioStream],
+                     ['currentsubtitle', Subtitle], ['currentvideostream', VideoStream],
+                     ['subtitles', Subtitle, true], ['time', Global::GlobalTime],
+                     ['totaltime', Global::GlobalTime], ['videostreams', VideoStream, true]
+
+        def initialize(audio_streams, cache_percentage, can_change_speed, can_move, can_repeat, can_rotate, can_seek,
+                       can_shuffle, can_zoom, current_audio_stream, current_subtitle, current_video_stream, live,
+                       party_mode, percentage, playlist_id, position, repeat, shuffled, speed,
+                       subtitle_enabled, subtitles, time, total_time, type, video_streams)
+          type = type.nil? ? PlayerType::VIDEO : type
+          playlist_id = playlist_id.nil? ? -1 : playlist_id
+          position = position.nil? ? -1 : position
+          repeat = repeat.nil? ? PlayerRepeat::OFF : repeat
+
+          @audio_streams = audio_streams
+          @cache_percentage = cache_percentage
+          @can_change_speed = can_change_speed
+          @can_move = can_move
+          @can_repeat = can_repeat
+          @can_rotate = can_rotate
+          @can_seek = can_seek
+          @can_shuffle = can_shuffle
+          @can_zoom = can_zoom
+          @current_audio_stream = current_audio_stream
+          @current_subtitle = current_subtitle
+          @current_video_stream = current_video_stream
+          @live = live
+          @party_mode = party_mode
+          @percentage = percentage
+          @playlist_id = playlist_id
+          @position = position
+          @repeat = repeat
+          @shuffled = shuffled
+          @speed = speed
+          @subtitle_enabled = subtitle_enabled
+          @subtitles = subtitles
+          @time = time
+          @total_time = total_time
+          @type = type
+          @video_streams = video_streams
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/player/seek_jump_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # defines  the jump size for seek
+      module SeekJump
+        include Extensions::Iterable
+
+        SMALL_FORWARD = 'smallforward'
+        SMALL_BACKWARD = 'smallbackward'
+        BIG_FORWARD = 'bigforward'
+        BIG_BACKWARD = 'bigbackward'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/player/seek_returned_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # return value of Player.Seek
+      class SeekReturned
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :percentage, :time, :total_time
+
+        type_mapping ['time', Global::GlobalTime], ['totaltime', Global::GlobalTime]
+
+        def initialize(percentage, time, total_time)
+          @percentage = percentage
+          @time = time
+          @total_time = total_time
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/player/subtitle_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # Player Subtitle https://kodi.wiki/view/JSON-RPC_API/v12#Player.Subtitle
+      class Subtitle
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :index, :is_default, :is_forced, :is_impaired, :language, :name
+
+        def initialize(index, is_default, is_forced, is_impaired, language, name)
+          @index = index
+          @is_default = is_default
+          @is_forced = is_forced
+          @is_impaired = is_impaired
+          @language = language
+          @name = name
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/player/video_stream_type.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # Player.Video.Stream https://kodi.wiki/view/JSON-RPC_API/v12#Player.Video.Stream
+      class VideoStream
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :codec, :height, :index, :language, :name, :width, :duration, :aspect
+
+        def initialize(codec, height, index, language, name, width, duration, aspect)
+          @codec = codec
+          @height = height
+          @index = index
+          @language = language
+          @name = name
+          @width = width
+          @duration = duration
+          @aspect = aspect
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/player/view_mode_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # Player.ViewMode https://kodi.wiki/view/JSON-RPC_API/v12#Player.ViewMode
+      module ViewMode
+        extend Extensions::Iterable
+
+        NORMAL = 'normal'
+        ZOOM = 'zoom'
+        STRETCH_4X3 = 'strech4x3'
+        WIDE_ZOOM = 'widezoom'
+        STRETCH_16X9 = 'stretch16x9'
+        ORIGINAL = 'original'
+        STRETCH_16X9_NONLIN = 'stretch16x9nonline'
+        ZOOM_120_WIDTH = 'zoom120width'
+        ZOOM_110_WIDTH = 'zoom110width'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/player/zoom_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Player
+      # enum for in/out zoom
+      module Zoom
+        extend Extensions::Iterable
+
+        IN = 'in'
+        OUT = 'out'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/profiles/details_profile_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Profiles
+      # Profiles.Details.Profile https://kodi.wiki/view/JSON-RPC_API/v12#Profiles.Details.Profile
+      class DetailsProfile
+        include Extensions::Comparable
+        include Items::ItemDetailsBase
+        extend Extensions::Creatable
+
+        attr_reader :lock_mode, :thumbnail
+
+        fields_to_map %w[lock_mode thumbnail label]
+
+        def initialize(lock_mode, thumbnail, label)
+          @lock_mode = lock_mode
+          @thumbnail = thumbnail
+          item_details_base(label)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/profiles/fields_profile_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Profiles
+      # Profiles.Fields.Profile https://kodi.wiki/view/JSON-RPC_API/v12#Profiles.Fields.Profile
+      module FieldsProfile
+        extend Extensions::Iterable
+
+        LOCK_MODE = 'lockmode'
+        THUMBNAIL = 'thumbnail'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/profiles/get_profiles_returned_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Profiles
+      # return type for Profiles.GetProfiles
+      class GetProfilesReturned
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :limits, :profiles
+
+        type_mapping ['limits', List::ListLimitsReturned], ['profiles', DetailsProfile, true]
+
+        def initialize(limits, profiles)
+          @limits = limits
+          @profiles = profiles
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/profiles/profile_password_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Profiles
+      # Profiles.Password https://kodi.wiki/view/JSON-RPC_API/v12#Profiles.Password
+      class ProfilePassword
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :value, :encryption
+
+        def initialize(value, encryption = Types::Global::PasswordEncryption::MD5)
+          @value = value
+          @encryption = encryption
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/{pvr_type.rb → pvr/channel_type_type.rb}

@@ -3,15 +3,13 @@
 module KodiClient
   module Types
     module PVR
-
       # PVR.Channel.Type https://kodi.wiki/view/JSON-RPC_API/v12#PVR.Channel.Type
       module ChannelType
-        extend Iterable
-        
+        extend Extensions::Iterable
+
         TV = 'TV'
         RADIO = 'Radio'
       end
     end
   end
 end
-

data/lib/kodi_client/types/system/property_name_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module System
+      # System.Property.Name https://kodi.wiki/view/JSON-RPC_API/v12#System.Property.Name
+      module PropertyName
+        extend Extensions::Iterable
+
+        CAN_SHUTDOWN = 'canshutdown'
+        CAN_SUSPEND = 'cansuspend'
+        CAN_HIBERNATE = 'canhibernate'
+        CAN_REBOOT = 'canreboot'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/{system_types.rb → system/property_value_type.rb}

@@ -3,21 +3,10 @@
 module KodiClient
   module Types
     module System
-
-      # System.Property.Name https://kodi.wiki/view/JSON-RPC_API/v12#System.Property.Name
-      module PropertyName
-        extend Iterable
-
-        CAN_SHUTDOWN = 'canshutdown'
-        CAN_SUSPEND = 'cansuspend'
-        CAN_HIBERNATE = 'canhibernate'
-        CAN_REBOOT = 'canreboot'
-      end
-
       # System.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#System.Property.Value
       class PropertyValue
-        include Comparable
-        extend Creatable
+        include Extensions::Comparable
+        extend Extensions::Creatable
 
         attr_reader :can_hibernate, :can_reboot, :can_shutdown, :can_suspend
 

data/lib/kodi_client/types/video/stream_details_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Video
+      # Video.Streams https://kodi.wiki/view/JSON-RPC_API/v12#Video.Streams
+      class StreamDetails
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :audio, :subtitle, :video
+
+        type_mapping ['audio', Player::AudioStream, true], ['subtitle', Player::Subtitle, true],
+                     ['video', Player::VideoStream, true]
+
+        def initialize(audio, subtitle, video)
+          @audio = audio
+          @subtitle = subtitle
+          @video = video
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/video/video_cast_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Video
+      # Video.Cast https://kodi.wiki/view/JSON-RPC_API/v12#Video.Cast
+      class VideoCast
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :name, :order, :role, :thumbnail
+
+        def initialize(name, order, role, thumbnail)
+          @name = name
+          @order = order
+          @role = role
+          @thumbnail = thumbnail
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/video/video_details_base_type.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Video
+      # Video.Details.Base https://kodi.wiki/view/JSON-RPC_API/v12#Video.Details.Base
+      module VideoDetailsBase
+        include Media::MediaDetailsBase
+
+        attr_reader :art, :play_count
+
+        def video_details_base_mappings
+          media_details_base_mappings
+        end
+
+        def video_details_base_by_hash(hash)
+          video_details_base(*Extensions::Creatable.hash_to_arr(hash, %w[art play_count fan_art thumbnail label],
+                                                                video_details_base_mappings))
+        end
+
+        def video_details_base(art, play_count, fan_art, thumbnail, label)
+          @art = art
+          @play_count = play_count
+          media_details_base(fan_art, thumbnail, label)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/video/video_details_file_type.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Video
+      # Video.Details.File https://kodi.wiki/view/JSON-RPC_API/v12#Video.Details.File
+      module VideoDetailsFile
+        include VideoDetailsItem
+
+        attr_reader :director, :resume, :runtime, :stream_details
+
+        def video_details_file_mappings
+          mappings = {
+            'resume' => Extensions::Creatable::CreateMap.new(VideoResume),
+            'streamdetails' => Extensions::Creatable::CreateMap.new(StreamDetails)
+          }
+          mappings.merge(video_details_item_mappings)
+        end
+
+        def video_details_file_by_hash(hash)
+          video_details_file(*Extensions::Creatable.hash_to_arr(hash, %w[director resume runtime stream_details date_added
+                                                             file last_played plot title art play_count fan_art
+                                                             thumbnail label], video_details_file_mappings))
+        end
+
+        def video_details_file(director, resume, runtime, stream_details, date_added, file, last_played, plot, title,
+                               art, play_count, fan_art, thumbnail, label)
+          @director = director
+          @resume = resume
+          @runtime = runtime
+          @stream_details = stream_details
+          video_details_item(date_added, file, last_played, plot, title, art, play_count, fan_art, thumbnail, label)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/video/video_details_item_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Video
+      # Video.Details.Item https://kodi.wiki/view/JSON-RPC_API/v12#Video.Details.Item
+      module VideoDetailsItem
+        include VideoDetailsMedia
+
+        attr_reader :date_added, :file, :last_played, :plot
+
+        def video_details_item_mappings
+          video_details_media_mappings
+        end
+
+        def video_details_item_by_hash(hash)
+          video_details_item(*Extensions::Creatable.hash_to_arr(hash, %w[date_added file last_played plot title art
+                                                             play_count fan_art thumbnail label],
+                                                                video_details_item_mappings))
+        end
+
+        def video_details_item(date_added, file, last_played, plot, title, art, play_count, fan_art, thumbnail, label)
+          @date_added = date_added
+          @file = file
+          @last_played = last_played
+          @plot = plot
+          video_details_media(title, art, play_count, fan_art, thumbnail, label)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/video/video_details_media_type.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Video
+      # Video.Details.Media https://kodi.wiki/view/JSON-RPC_API/v12#Video.Details.Media
+      module VideoDetailsMedia
+        include VideoDetailsBase
+
+        attr_reader :title
+
+        def video_details_media_mappings
+          video_details_base_mappings
+        end
+
+        def video_details_media_by_hash(hash)
+          video_details_media(*Extensions::Creatable.hash_to_arr(hash, %w[title art play_count fan_art thumbnail label]),
+                              video_details_base_mappings)
+        end
+
+        def video_details_media(title, art, play_count, fan_art, thumbnail, label)
+          @title = title
+          video_details_base(art, play_count, fan_art, thumbnail, label)
+        end
+      end
+    end
+  end
+end