plexruby/docs/sdks/video/README.md

Video

Overview

API Calls that perform operations with Plex Media Server Videos

Available Operations

• get_timeline - Get the timeline for a media item
• start_universal_transcode - Start Universal Transcode

get_timeline

Get the timeline for a media item

Example Usage

require 'plexruby'


s = ::OpenApiSDK::PlexAPI.new(
      x_plex_client_identifier: "Postman",
    )
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)


req = ::OpenApiSDK::Operations::GetTimelineRequest.new(
  rating_key: 716.56,
  key: "<key>",
  state: ::OpenApiSDK::Operations::State::PAUSED,
  has_mde: 7574.33,
  time: 3327.51,
  duration: 7585.39,
  context: "<value>",
  play_queue_item_id: 1406.21,
  play_back_time: 2699.34,
  row: 3536.42,
)
    
res = s.video.get_timeline(req)

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::OpenApiSDK::Operations::GetTimelineRequest	✔️	The request object to use for the request.

Response

T.nilable(::OpenApiSDK::Operations::GetTimelineResponse)

start_universal_transcode

Begin a Universal Transcode Session

Example Usage

require 'plexruby'


s = ::OpenApiSDK::PlexAPI.new(
      x_plex_client_identifier: "Postman",
    )
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)


req = ::OpenApiSDK::Operations::StartUniversalTranscodeRequest.new(
  has_mde: 8924.99,
  path: "/etc/mail",
  media_index: 9962.95,
  part_index: 1232.82,
  protocol: "<value>",
)
    
res = s.video.start_universal_transcode(req)

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::OpenApiSDK::Operations::StartUniversalTranscodeRequest	✔️	The request object to use for the request.

Response

T.nilable(::OpenApiSDK::Operations::StartUniversalTranscodeResponse)