mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
25ed9aa97d
* `plex-api.general.getServerInfo()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.general.getSourceConnectionInformation()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.general.getTransientToken()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.events.getNotifications()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.events.connectWebSocket()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.preferences.setPreferences()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.preferences.getPreference()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.rate.setRating()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.timeline.markPlayed()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.timeline.report()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.timeline.unscrobble()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.activities.cancelActivity()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.butler.stopTask()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.butler.startTask()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.downloadQueue.getDownloadQueue()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.downloadQueue.addDownloadQueueItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.downloadQueue.listDownloadQueueItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.downloadQueue.getItemDecision()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.downloadQueue.getDownloadQueueMedia()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.downloadQueue.removeDownloadQueueItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.downloadQueue.getDownloadQueueItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.downloadQueue.restartProcessingDownloadQueueItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.getAllHubs()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.getContinueWatching()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.getHubItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.getPromotedHubs()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.getMetadataHubs()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.getPostplayHubs()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.getRelatedHubs()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.getSectionHubs()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.resetSectionDefaults()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.listHubs()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.createCustomHub()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.moveHub()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.deleteCustomHub()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.hubs.updateHubVisibility()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.search.searchHubs()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.search.voiceSearchHubs()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getLibraryItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.ingestTransientItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getLibraryMatches()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.optimizeDatabase()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getRandomArtwork()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.addSection()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getSectionsPrefs()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.refreshSectionsMetadata()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getTags()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.deleteMetadataItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.editMetadataItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.detectAds()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getAllItemLeaves()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.analyzeMetadata()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.generateThumbs()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.detectCredits()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getExtras()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.addExtras()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getFile()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.startBifGeneration()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.detectIntros()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.createMarker()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.matchItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.listMatches()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.mergeItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.listSonicallySimilar()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.setItemPreferences()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.refreshItemsMetadata()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getRelatedItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.listSimilar()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.splitItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.addSubtitles()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getItemTree()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.unmatch()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.listTopUsers()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.detectVoiceActivity()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getAugmentationStatus()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.setStreamSelection()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getPerson()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.listPersonMedia()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.deleteLibrarySection()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getLibraryDetails()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.editSection()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.updateItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.startAnalysis()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.autocomplete()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getCollections()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getCommon()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.emptyTrash()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getSectionFilters()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getFirstCharacters()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.deleteIndexes()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.deleteIntros()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getSectionPreferences()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.setSectionPreferences()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.cancelRefresh()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.refreshSection()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getAvailableSorts()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getStreamLevels()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getStreamLoudness()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getChapterImage()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.setItemArtwork()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.updateItemArtwork()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.deleteMarker()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.editMarker()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.deleteMediaItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getPartIndex()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.deleteCollection()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getSectionImage()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.deleteStream()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getStream()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.setStreamOffset()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getItemArtwork()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getMediaPart()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.library.getImageFromBif()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.collections.createCollection()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.dvRs.createDvr()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.dvRs.deleteDvr()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.dvRs.getDvr()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.dvRs.deleteLineup()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.dvRs.addLineup()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.dvRs.setDvrPreferences()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.dvRs.stopDvrReload()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.dvRs.reloadGuide()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.dvRs.tuneChannel()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.dvRs.removeDeviceFromDvr()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.dvRs.addDeviceToDvr()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.epg.computeChannelMap()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.epg.getChannels()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.epg.getLineup()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.epg.getLineupChannels()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.epg.getCountriesLineups()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.epg.getCountryRegions()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.epg.listLineups()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.liveTv.getLiveTvSession()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.liveTv.getSessionPlaylistIndex()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.liveTv.getSessionSegment()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.log.writeMessage()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.log.enablePapertrail()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.devices.getAvailableGrabbers()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.devices.addDevice()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.devices.removeDevice()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.devices.getDeviceDetails()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.devices.modifyDevice()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.devices.setChannelmap()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.devices.getDevicesChannels()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.devices.setDevicePreferences()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.devices.stopScan()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.devices.scan()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.devices.getThumb()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.provider.addProvider()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.provider.deleteMediaProvider()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.subscriptions.getAllSubscriptions()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.subscriptions.createSubscription()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.subscriptions.getTemplate()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.subscriptions.cancelGrab()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.subscriptions.deleteSubscription()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.subscriptions.getSubscription()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.subscriptions.editSubscriptionPreferences()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.subscriptions.reorderSubscription()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.transcoder.transcodeImage()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.transcoder.makeDecision()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.transcoder.triggerFallback()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.transcoder.transcodeSubtitles()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.transcoder.startTranscodeSession()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.playlist.listPlaylists()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.playlist.getPlaylist()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.playlist.getPlaylistItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.createPlaylist()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.uploadPlaylist()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.deletePlaylist()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.updatePlaylist()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.getPlaylistGenerators()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.clearPlaylistItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.addPlaylistItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.deletePlaylistItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.getPlaylistGenerator()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.modifyPlaylistGenerator()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.getPlaylistGeneratorItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.movePlaylistItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryPlaylists.refreshPlaylist()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.playQueue.createPlayQueue()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.playQueue.getPlayQueue()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.playQueue.addToPlayQueue()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.playQueue.clearPlayQueue()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.playQueue.resetPlayQueue()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.playQueue.shuffle()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.playQueue.unshuffle()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.playQueue.deletePlayQueueItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.playQueue.movePlayQueueItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.ultraBlur.getColors()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.ultraBlur.getImage()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.status.listPlaybackHistory()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.status.terminateSession()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.status.deleteHistory()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.status.getHistoryItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.updater.applyUpdates()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.updater.checkUpdates()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.getCollectionItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.getMetadataItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.getAlbums()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.listContent()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.getAllLeaves()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.getArts()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.getCategories()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.getCluster()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.getSonicPath()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.getFolders()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.listMoments()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.getSonicallySimilar()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.content.getCollectionImage()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryCollections.addCollectionItems()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryCollections.deleteCollectionItem()`: `request` **Changed** **Breaking** ⚠️ * `plex-api.libraryCollections.moveCollectionItem()`: `request` **Changed** **Breaking** ⚠️
96 lines
99 KiB
Markdown
96 lines
99 KiB
Markdown
# StartTranscodeSessionRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import {
|
|
Extension,
|
|
StartTranscodeSessionLocation,
|
|
StartTranscodeSessionProtocol,
|
|
StartTranscodeSessionRequest,
|
|
StartTranscodeSessionSubtitles,
|
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
import { AdvancedSubtitles, BoolInt, TranscodeType } from "@lukehagar/plexjs/sdk/models/shared";
|
|
|
|
let value: StartTranscodeSessionRequest = {
|
|
transcodeType: TranscodeType.Video,
|
|
extension: Extension.M3u8,
|
|
advancedSubtitles: AdvancedSubtitles.Burn,
|
|
audioBoost: 50,
|
|
audioChannelCount: 5,
|
|
autoAdjustQuality: BoolInt.One,
|
|
autoAdjustSubtitle: BoolInt.One,
|
|
directPlay: BoolInt.One,
|
|
directStream: BoolInt.One,
|
|
directStreamAudio: BoolInt.One,
|
|
disableResolutionRotation: BoolInt.One,
|
|
hasMDE: BoolInt.One,
|
|
location: StartTranscodeSessionLocation.Wan,
|
|
mediaBufferSize: 102400,
|
|
mediaIndex: 0,
|
|
musicBitrate: 5000,
|
|
offset: 90.5,
|
|
partIndex: 0,
|
|
path: "/library/metadata/151671",
|
|
peakBitrate: 12000,
|
|
photoResolution: "1080x1080",
|
|
protocol: StartTranscodeSessionProtocol.Dash,
|
|
secondsPerSegment: 5,
|
|
subtitleSize: 50,
|
|
subtitles: StartTranscodeSessionSubtitles.Segmented,
|
|
videoBitrate: 12000,
|
|
videoQuality: 50,
|
|
videoResolution: "1080x1080",
|
|
xPlexClientProfileExtra:
|
|
"add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)",
|
|
xPlexClientProfileName: "generic",
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
|
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
|
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
|
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
|
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
|
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
|
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
|
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
|
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
|
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
|
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
|
| `transcodeType` | [shared.TranscodeType](../../../sdk/models/shared/transcodetype.md) | :heavy_check_mark: | Type of transcode media | |
|
|
| `transcodeSessionId` | *string* | :heavy_minus_sign: | Transcode session UUID | |
|
|
| `extension` | [operations.Extension](../../../sdk/models/operations/extension.md) | :heavy_check_mark: | Extension <br/> | |
|
|
| `advancedSubtitles` | [shared.AdvancedSubtitles](../../../sdk/models/shared/advancedsubtitles.md) | :heavy_minus_sign: | Indicates how incompatible advanced subtitles (such as ass/ssa) should be included: * 'burn' - Burn incompatible advanced text subtitles into the video stream * 'text' - Transcode incompatible advanced text subtitles to a compatible text format, even if some markup is lost<br/> | burn |
|
|
| `audioBoost` | *number* | :heavy_minus_sign: | Percentage of original audio loudness to use when transcoding (100 is equivalent to original volume, 50 is half, 200 is double, etc) | 50 |
|
|
| `audioChannelCount` | *number* | :heavy_minus_sign: | Target video number of audio channels. | 5 |
|
|
| `autoAdjustQuality` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports ABR. | 1 |
|
|
| `autoAdjustSubtitle` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates if the server should adjust subtitles based on Voice Activity Data. | 1 |
|
|
| `directPlay` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct playing the indicated content. | 1 |
|
|
| `directStream` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the video of the indicated content. | 1 |
|
|
| `directStreamAudio` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the audio of the indicated content. | 1 |
|
|
| `disableResolutionRotation` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates if resolution should be adjusted for orientation. | 1 |
|
|
| `hasMDE` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | 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 | 1 |
|
|
| `location` | [operations.StartTranscodeSessionLocation](../../../sdk/models/operations/starttranscodesessionlocation.md) | :heavy_minus_sign: | Network type of the client, can be used to help determine target bitrate. | wan |
|
|
| `mediaBufferSize` | *number* | :heavy_minus_sign: | 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. | 102400 |
|
|
| `mediaIndex` | *number* | :heavy_minus_sign: | Index of the media to transcode. -1 or not specified indicates let the server choose. | 0 |
|
|
| `musicBitrate` | *number* | :heavy_minus_sign: | Target bitrate for audio only files (in kbps, used to transcode). | 5000 |
|
|
| `offset` | *number* | :heavy_minus_sign: | Offset from the start of the media (in seconds). | 90.5 |
|
|
| `partIndex` | *number* | :heavy_minus_sign: | Index of the part to transcode. -1 or not specified indicates the server should join parts together in a transcode | 0 |
|
|
| `path` | *string* | :heavy_minus_sign: | Internal PMS path of the media to transcode. | /library/metadata/151671 |
|
|
| `peakBitrate` | *number* | :heavy_minus_sign: | Maximum bitrate (in kbps) to use in ABR. | 12000 |
|
|
| `photoResolution` | *string* | :heavy_minus_sign: | Target photo resolution. | 1080x1080 |
|
|
| `protocol` | [operations.StartTranscodeSessionProtocol](../../../sdk/models/operations/starttranscodesessionprotocol.md) | :heavy_minus_sign: | Indicates the network streaming protocol to be used for the transcode session: * 'http' - include the file in the http response such as MKV streaming * 'hls' - hls stream (RFC 8216) * 'dash' - dash stream (ISO/IEC 23009-1:2022)<br/> | dash |
|
|
| `secondsPerSegment` | *number* | :heavy_minus_sign: | Number of seconds to include in each transcoded segment | 5 |
|
|
| `subtitleSize` | *number* | :heavy_minus_sign: | Percentage of original subtitle size to use when burning subtitles (100 is equivalent to original size, 50 is half, ect) | 50 |
|
|
| `subtitles` | [operations.StartTranscodeSessionSubtitles](../../../sdk/models/operations/starttranscodesessionsubtitles.md) | :heavy_minus_sign: | Indicates how subtitles should be included: * 'auto' - Compute the appropriate subtitle setting automatically * 'burn' - Burn the selected subtitle; auto if no selected subtitle * 'none' - Ignore all subtitle streams * 'sidecar' - The selected subtitle should be provided as a sidecar * 'embedded' - The selected subtitle should be provided as an embedded stream * 'segmented' - The selected subtitle should be provided as a segmented stream<br/> | Burn |
|
|
| `videoBitrate` | *number* | :heavy_minus_sign: | Target video bitrate (in kbps). | 12000 |
|
|
| `videoQuality` | *number* | :heavy_minus_sign: | Target photo quality. | 50 |
|
|
| `videoResolution` | *string* | :heavy_minus_sign: | Target maximum video resolution. | 1080x1080 |
|
|
| `xPlexClientProfileExtra` | *string* | :heavy_minus_sign: | See [Profile Augmentations](#section/API-Info/Profile-Augmentations) . | add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash) |
|
|
| `xPlexClientProfileName` | *string* | :heavy_minus_sign: | Which built in Client Profile to use in the decision. Generally should only be used to specify the Generic profile. | generic |
|
|
| `xPlexSessionIdentifier` | *string* | :heavy_minus_sign: | Unique per client playback session. Used if a client can playback multiple items at a time (such as a browser with multiple tabs) | | |