Skip to content

Latest commit

 

History

History
180 lines (116 loc) · 9.55 KB

README.md

File metadata and controls

180 lines (116 loc) · 9.55 KB
Raw

Sessions

(sessions)

Overview

API Calls that perform search operations with Plex Media Server Sessions

Available Operations

get_sessions

This will retrieve the "Now Playing" Information of the PMS.

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.sessions.get_sessions()

if ! res.object.nil?
  # handle response
end

Response

T.nilable(::PlexRubySDK::Operations::GetSessionsResponse)

get_session_history

This will Retrieve a listing of all history views.

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.sessions.get_session_history(sort="<value>", account_id=1, filter=::PlexRubySDK::Operations::QueryParamFilter.new(), library_section_id=12)

if ! res.object.nil?
  # handle response
end

Parameters

Parameter Type Required Description Example
sort T.nilable(::String) ➖ Sorts the results by the specified field followed by the direction (asc, desc)
account_id T.nilable(::Integer) ➖ Filter results by those that are related to a specific users id
 1
filter T.nilable(::PlexRubySDK::Operations::QueryParamFilter) ➖ Filters content by field and direction/equality
(Unknown if viewedAt is the only supported column)
 {
"viewed-at-greater-than": {
"value": "viewedAt\u003e"
},
"viewed-at-greater-than-or-equal-to": {
"value": "viewedAt\u003e=\u003e"
},
"viewed-at-less-than": {
"value": "viewedAt\u003c"
}
}
library_section_id T.nilable(::Integer) ➖ Filters the results based on the id of a valid library section
 12

Response

T.nilable(::PlexRubySDK::Operations::GetSessionHistoryResponse)

get_transcode_sessions

Get Transcode Sessions

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.sessions.get_transcode_sessions()

if ! res.object.nil?
  # handle response
end

Response

T.nilable(::PlexRubySDK::Operations::GetTranscodeSessionsResponse)

stop_transcode_session

Stop a Transcode Session

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.sessions.stop_transcode_session(session_key="zz7llzqlx8w9vnrsbnwhbmep")

if res.status_code == 200
  # handle response
end

Parameters

Parameter Type Required Description Example
session_key ::String ✔️ the Key of the transcode session to stop zz7llzqlx8w9vnrsbnwhbmep

Response

T.nilable(::PlexRubySDK::Operations::StopTranscodeSessionResponse)