-
public final class MediaInfoApi
-
-
Constructor Summary
Constructors Constructor Description MediaInfoApi(KtorClient api)
-
Method Summary
Modifier and Type Method Description final Response<Unit>
closeLiveStream(String liveStreamId)
Closes a media source. final Response<ByteReadChannel>
getBitrateTestBytes(Integer size)
Tests the network with a request with the size of the bitrate. final String
getBitrateTestBytesUrl(Integer size, Boolean includeCredentials)
Tests the network with a request with the size of the bitrate. final Response<PlaybackInfoResponse>
getPlaybackInfo(UUID itemId, UUID userId)
Gets live playback media info for an item. final Response<PlaybackInfoResponse>
getPostedPlaybackInfo(UUID itemId, PlaybackInfoDto data)
For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. final Response<PlaybackInfoResponse>
getPostedPlaybackInfoDeprecated(UUID itemId, UUID userId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, String mediaSourceId, String liveStreamId, Boolean autoOpenLiveStream, Boolean enableDirectPlay, Boolean enableDirectStream, Boolean enableTranscoding, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, PlaybackInfoDto data)
For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. final Response<LiveStreamResponse>
openLiveStream(String openToken, UUID userId, String playSessionId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, UUID itemId, Boolean enableDirectPlay, Boolean enableDirectStream, OpenLiveStreamDto data)
Opens a media source. -
-
Constructor Detail
-
MediaInfoApi
MediaInfoApi(KtorClient api)
-
-
Method Detail
-
closeLiveStream
final Response<Unit> closeLiveStream(String liveStreamId)
Closes a media source.
- Parameters:
liveStreamId
- The livestream id.
-
getBitrateTestBytes
final Response<ByteReadChannel> getBitrateTestBytes(Integer size)
Tests the network with a request with the size of the bitrate.
- Parameters:
size
- The bitrate.
-
getBitrateTestBytesUrl
final String getBitrateTestBytesUrl(Integer size, Boolean includeCredentials)
Tests the network with a request with the size of the bitrate.
- Parameters:
size
- The bitrate.includeCredentials
- Add the access token to the url to make an authenticated request.
-
getPlaybackInfo
final Response<PlaybackInfoResponse> getPlaybackInfo(UUID itemId, UUID userId)
Gets live playback media info for an item.
- Parameters:
itemId
- The item id.userId
- The user id.
-
getPostedPlaybackInfo
final Response<PlaybackInfoResponse> getPostedPlaybackInfo(UUID itemId, PlaybackInfoDto data)
For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.
- Parameters:
itemId
- The item id.
-
getPostedPlaybackInfoDeprecated
@Deprecated(message = This member is deprecated and may be removed in the future) final Response<PlaybackInfoResponse> getPostedPlaybackInfoDeprecated(UUID itemId, UUID userId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, String mediaSourceId, String liveStreamId, Boolean autoOpenLiveStream, Boolean enableDirectPlay, Boolean enableDirectStream, Boolean enableTranscoding, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, PlaybackInfoDto data)
For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.
- Parameters:
itemId
- The item id.userId
- The user id.maxStreamingBitrate
- The maximum streaming bitrate.startTimeTicks
- The start time in ticks.audioStreamIndex
- The audio stream index.subtitleStreamIndex
- The subtitle stream index.maxAudioChannels
- The maximum number of audio channels.mediaSourceId
- The media source id.liveStreamId
- The livestream id.autoOpenLiveStream
- Whether to auto open the livestream.enableDirectPlay
- Whether to enable direct play.enableDirectStream
- Whether to enable direct stream.enableTranscoding
- Whether to enable transcoding.allowVideoStreamCopy
- Whether to allow to copy the video stream.allowAudioStreamCopy
- Whether to allow to copy the audio stream.
-
openLiveStream
final Response<LiveStreamResponse> openLiveStream(String openToken, UUID userId, String playSessionId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, UUID itemId, Boolean enableDirectPlay, Boolean enableDirectStream, OpenLiveStreamDto data)
Opens a media source.
- Parameters:
openToken
- The open token.userId
- The user id.playSessionId
- The play session id.maxStreamingBitrate
- The maximum streaming bitrate.startTimeTicks
- The start time in ticks.audioStreamIndex
- The audio stream index.subtitleStreamIndex
- The subtitle stream index.maxAudioChannels
- The maximum number of audio channels.itemId
- The item id.enableDirectPlay
- Whether to enable direct play.enableDirectStream
- Whether to enable direct stream.
-
-
-
-