plexcsharp/LukeHagar/PlexAPI/SDK/Models/Requests/StartTranscodeSessionRequest.cs

//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
//
// Changes to this file may cause incorrect behavior and will be lost when
// the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------
#nullable enable
namespace LukeHagar.PlexAPI.SDK.Models.Requests
{
    using LukeHagar.PlexAPI.SDK.Models.Components;
    using LukeHagar.PlexAPI.SDK.Models.Requests;
    using LukeHagar.PlexAPI.SDK.Utils;
    
    public class StartTranscodeSessionRequest
    {

        /// <summary>
        /// Indicates the client accepts the indicated media types
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=accepts")]
        public Accepts? Accepts { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml;

        /// <summary>
        /// An opaque identifier unique to the client
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Client-Identifier")]
        public string? ClientIdentifier { get; set; }

        /// <summary>
        /// The name of the client product
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Product")]
        public string? Product { get; set; }

        /// <summary>
        /// The version of the client application
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Version")]
        public string? Version { get; set; }

        /// <summary>
        /// The platform of the client
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Platform")]
        public string? Platform { get; set; }

        /// <summary>
        /// The version of the platform
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Platform-Version")]
        public string? PlatformVersion { get; set; }

        /// <summary>
        /// A relatively friendly name for the client device
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Device")]
        public string? Device { get; set; }

        /// <summary>
        /// A potentially less friendly identifier for the device model
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Model")]
        public string? Model { get; set; }

        /// <summary>
        /// The device vendor
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Device-Vendor")]
        public string? DeviceVendor { get; set; }

        /// <summary>
        /// A friendly name for the client
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Device-Name")]
        public string? DeviceName { get; set; }

        /// <summary>
        /// The marketplace on which the client application is distributed
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Marketplace")]
        public string? Marketplace { get; set; }

        /// <summary>
        /// Type of transcode media
        /// </summary>
        [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=transcodeType")]
        public TranscodeType TranscodeType { get; set; } = default!;

        /// <summary>
        /// Transcode session UUID
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=transcodeSessionId")]
        public string? TranscodeSessionId { get; set; }

        /// <summary>
        /// Extension <br/>
        /// 
        /// <remarks>
        /// 
        /// </remarks>
        /// </summary>
        [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=extension")]
        public Extension Extension { get; set; } = default!;

        /// <summary>
        /// Indicates how incompatible advanced subtitles (such as ass/ssa) should be included: * &apos;burn&apos; - Burn incompatible advanced text subtitles into the video stream * &apos;text&apos; - Transcode incompatible advanced text subtitles to a compatible text format, even if some markup is lost<br/>
        /// 
        /// <remarks>
        /// 
        /// </remarks>
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=advancedSubtitles")]
        public Models.Components.AdvancedSubtitles? AdvancedSubtitles { get; set; }

        /// <summary>
        /// Percentage of original audio loudness to use when transcoding (100 is equivalent to original volume, 50 is half, 200 is double, etc)
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=audioBoost")]
        public long? AudioBoost { get; set; }

        /// <summary>
        /// Target video number of audio channels.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=audioChannelCount")]
        public long? AudioChannelCount { get; set; }

        /// <summary>
        /// Indicates the client supports ABR.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=autoAdjustQuality")]
        public BoolInt? AutoAdjustQuality { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        /// <summary>
        /// Indicates if the server should adjust subtitles based on Voice Activity Data.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=autoAdjustSubtitle")]
        public BoolInt? AutoAdjustSubtitle { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        /// <summary>
        /// Indicates the client supports direct playing the indicated content.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=directPlay")]
        public BoolInt? DirectPlay { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        /// <summary>
        /// Indicates the client supports direct streaming the video of the indicated content.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=directStream")]
        public BoolInt? DirectStream { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        /// <summary>
        /// Indicates the client supports direct streaming the audio of the indicated content.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=directStreamAudio")]
        public BoolInt? DirectStreamAudio { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        /// <summary>
        /// Indicates if resolution should be adjusted for orientation.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=disableResolutionRotation")]
        public BoolInt? DisableResolutionRotation { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        /// <summary>
        /// Ignore client profiles when determining if direct play is possible. Only has an effect when directPlay=1 and both mediaIndex and partIndex are specified and neither are -1
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=hasMDE")]
        public BoolInt? HasMDE { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        /// <summary>
        /// Network type of the client, can be used to help determine target bitrate.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=location")]
        public StartTranscodeSessionQueryParamLocation? Location { get; set; }

        /// <summary>
        /// Buffer size used in playback (in KB). Clients should specify a lower bound if not known exactly. This value could make the difference between transcoding and direct play on bandwidth constrained networks.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=mediaBufferSize")]
        public long? MediaBufferSize { get; set; }

        /// <summary>
        /// Index of the media to transcode. -1 or not specified indicates let the server choose.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=mediaIndex")]
        public long? MediaIndex { get; set; }

        /// <summary>
        /// Target bitrate for audio only files (in kbps, used to transcode).
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=musicBitrate")]
        public long? MusicBitrate { get; set; }

        /// <summary>
        /// Offset from the start of the media (in seconds).
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=offset")]
        public double? Offset { get; set; }

        /// <summary>
        /// Index of the part to transcode. -1 or not specified indicates the server should join parts together in a transcode
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=partIndex")]
        public long? PartIndex { get; set; }

        /// <summary>
        /// Internal PMS path of the media to transcode.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=path")]
        public string? Path { get; set; }

        /// <summary>
        /// Maximum bitrate (in kbps) to use in ABR.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=peakBitrate")]
        public long? PeakBitrate { get; set; }

        /// <summary>
        /// Target photo resolution.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=photoResolution")]
        public string? PhotoResolution { get; set; }

        /// <summary>
        /// Indicates the network streaming protocol to be used for the transcode session: * &apos;http&apos; - include the file in the http response such as MKV streaming * &apos;hls&apos; - hls stream (RFC 8216) * &apos;dash&apos; - dash stream (ISO/IEC 23009-1:2022)<br/>
        /// 
        /// <remarks>
        /// 
        /// </remarks>
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=protocol")]
        public StartTranscodeSessionQueryParamProtocol? Protocol { get; set; }

        /// <summary>
        /// Number of seconds to include in each transcoded segment
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=secondsPerSegment")]
        public long? SecondsPerSegment { get; set; }

        /// <summary>
        /// Percentage of original subtitle size to use when burning subtitles (100 is equivalent to original size, 50 is half, ect)
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=subtitleSize")]
        public long? SubtitleSize { get; set; }

        /// <summary>
        /// Indicates how subtitles should be included: * &apos;auto&apos; - Compute the appropriate subtitle setting automatically * &apos;burn&apos; - Burn the selected subtitle; auto if no selected subtitle * &apos;none&apos; - Ignore all subtitle streams * &apos;sidecar&apos; - The selected subtitle should be provided as a sidecar * &apos;embedded&apos; - The selected subtitle should be provided as an embedded stream * &apos;segmented&apos; - The selected subtitle should be provided as a segmented stream<br/>
        /// 
        /// <remarks>
        /// 
        /// </remarks>
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=subtitles")]
        public StartTranscodeSessionQueryParamSubtitles? Subtitles { get; set; }

        /// <summary>
        /// Target video bitrate (in kbps).
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=videoBitrate")]
        public long? VideoBitrate { get; set; }

        /// <summary>
        /// Target photo quality.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=videoQuality")]
        public long? VideoQuality { get; set; }

        /// <summary>
        /// Target maximum video resolution.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=videoResolution")]
        public string? VideoResolution { get; set; }

        /// <summary>
        /// See <a href="#section/API-Info/Profile-Augmentations">Profile Augmentations</a> .
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Client-Profile-Extra")]
        public string? XPlexClientProfileExtra { get; set; }

        /// <summary>
        /// Which built in Client Profile to use in the decision. Generally should only be used to specify the Generic profile.
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Client-Profile-Name")]
        public string? XPlexClientProfileName { get; set; }

        /// <summary>
        /// Unique per client playback session.  Used if a client can playback multiple items at a time (such as a browser with multiple tabs)
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Session-Identifier")]
        public string? XPlexSessionIdentifier { get; set; }
    }
}