getVideoStream method

Future<Response<Uint8List>> getVideoStream({
  1. required String itemId,
  2. String? container,
  3. bool? static_,
  4. String? params,
  5. String? tag,
  6. @Deprecated('deviceProfileId is deprecated') String? deviceProfileId,
  7. String? playSessionId,
  8. String? segmentContainer,
  9. int? segmentLength,
  10. int? minSegments,
  11. String? mediaSourceId,
  12. String? deviceId,
  13. String? audioCodec,
  14. bool? enableAutoStreamCopy,
  15. bool? allowVideoStreamCopy,
  16. bool? allowAudioStreamCopy,
  17. bool? breakOnNonKeyFrames,
  18. int? audioSampleRate,
  19. int? maxAudioBitDepth,
  20. int? audioBitRate,
  21. int? audioChannels,
  22. int? maxAudioChannels,
  23. String? profile,
  24. String? level,
  25. double? framerate,
  26. double? maxFramerate,
  27. bool? copyTimestamps,
  28. int? startTimeTicks,
  29. int? width,
  30. int? height,
  31. int? maxWidth,
  32. int? maxHeight,
  33. int? videoBitRate,
  34. int? subtitleStreamIndex,
  35. SubtitleDeliveryMethod? subtitleMethod,
  36. int? maxRefFrames,
  37. int? maxVideoBitDepth,
  38. bool? requireAvc,
  39. bool? deInterlace,
  40. bool? requireNonAnamorphic,
  41. int? transcodingMaxAudioChannels,
  42. int? cpuCoreLimit,
  43. String? liveStreamId,
  44. bool? enableMpegtsM2TsMode,
  45. String? videoCodec,
  46. String? subtitleCodec,
  47. String? transcodeReasons,
  48. int? audioStreamIndex,
  49. int? videoStreamIndex,
  50. EncodingContext? context,
  51. Map<String, String>? streamOptions,
  52. bool? enableAudioVbrEncoding = true,
  53. CancelToken? cancelToken,
  54. Map<String, dynamic>? headers,
  55. Map<String, dynamic>? extra,
  56. ValidateStatus? validateStatus,
  57. ProgressCallback? onSendProgress,
  58. ProgressCallback? onReceiveProgress,
})

Gets a video stream.

Parameters:

  • itemId - The item id.
  • container - The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
  • static_ - Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
  • params - The streaming parameters.
  • tag - The tag.
  • deviceProfileId - Optional. The dlna device profile id to utilize.
  • playSessionId - The play session id.
  • segmentContainer - The segment container.
  • segmentLength - The segment length.
  • minSegments - The minimum number of segments.
  • mediaSourceId - The media version id, if playing an alternate version.
  • deviceId - The device id of the client requesting. Used to stop encoding processes when needed.
  • audioCodec - Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.
  • enableAutoStreamCopy - Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
  • allowVideoStreamCopy - Whether or not to allow copying of the video stream url.
  • allowAudioStreamCopy - Whether or not to allow copying of the audio stream url.
  • breakOnNonKeyFrames - Optional. Whether to break on non key frames.
  • audioSampleRate - Optional. Specify a specific audio sample rate, e.g. 44100.
  • maxAudioBitDepth - Optional. The maximum audio bit depth.
  • audioBitRate - Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
  • audioChannels - Optional. Specify a specific number of audio channels to encode to, e.g. 2.
  • maxAudioChannels - Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
  • profile - Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
  • level - Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
  • framerate - Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
  • maxFramerate - Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
  • copyTimestamps - Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
  • startTimeTicks - Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
  • width - Optional. The fixed horizontal resolution of the encoded video.
  • height - Optional. The fixed vertical resolution of the encoded video.
  • maxWidth - Optional. The maximum horizontal resolution of the encoded video.
  • maxHeight - Optional. The maximum vertical resolution of the encoded video.
  • videoBitRate - Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
  • subtitleStreamIndex - Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
  • subtitleMethod - Optional. Specify the subtitle delivery method.
  • maxRefFrames - Optional.
  • maxVideoBitDepth - Optional. The maximum video bit depth.
  • requireAvc - Optional. Whether to require avc.
  • deInterlace - Optional. Whether to deinterlace the video.
  • requireNonAnamorphic - Optional. Whether to require a non anamorphic stream.
  • transcodingMaxAudioChannels - Optional. The maximum number of audio channels to transcode.
  • cpuCoreLimit - Optional. The limit of how many cpu cores to use.
  • liveStreamId - The live stream id.
  • enableMpegtsM2TsMode - Optional. Whether to enable the MpegtsM2Ts mode.
  • videoCodec - Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.
  • subtitleCodec - Optional. Specify a subtitle codec to encode to.
  • transcodeReasons - Optional. The transcoding reason.
  • audioStreamIndex - Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
  • videoStreamIndex - Optional. The index of the video stream to use. If omitted the first video stream will be used.
  • context - Optional. The MediaBrowser.Model.Dlna.EncodingContext.
  • streamOptions - Optional. The streaming options.
  • enableAudioVbrEncoding - Optional. Whether to enable Audio Encoding.
  • cancelToken - A CancelToken that can be used to cancel the operation
  • headers - Can be used to add additional headers to the request
  • extras - Can be used to add flags to the request
  • validateStatus - A ValidateStatus callback that can be used to determine request success based on the HTTP status of the response
  • onSendProgress - A ProgressCallback that can be used to get the send progress
  • onReceiveProgress - A ProgressCallback that can be used to get the receive progress

Returns a Future containing a Response with a Uint8List as data Throws DioException if API call or serialization fails

Implementation

Future<Response<Uint8List>> getVideoStream({
  required String itemId,
  String? container,
  bool? static_,
  String? params,
  String? tag,
  @Deprecated('deviceProfileId is deprecated') String? deviceProfileId,
  String? playSessionId,
  String? segmentContainer,
  int? segmentLength,
  int? minSegments,
  String? mediaSourceId,
  String? deviceId,
  String? audioCodec,
  bool? enableAutoStreamCopy,
  bool? allowVideoStreamCopy,
  bool? allowAudioStreamCopy,
  bool? breakOnNonKeyFrames,
  int? audioSampleRate,
  int? maxAudioBitDepth,
  int? audioBitRate,
  int? audioChannels,
  int? maxAudioChannels,
  String? profile,
  String? level,
  double? framerate,
  double? maxFramerate,
  bool? copyTimestamps,
  int? startTimeTicks,
  int? width,
  int? height,
  int? maxWidth,
  int? maxHeight,
  int? videoBitRate,
  int? subtitleStreamIndex,
  SubtitleDeliveryMethod? subtitleMethod,
  int? maxRefFrames,
  int? maxVideoBitDepth,
  bool? requireAvc,
  bool? deInterlace,
  bool? requireNonAnamorphic,
  int? transcodingMaxAudioChannels,
  int? cpuCoreLimit,
  String? liveStreamId,
  bool? enableMpegtsM2TsMode,
  String? videoCodec,
  String? subtitleCodec,
  String? transcodeReasons,
  int? audioStreamIndex,
  int? videoStreamIndex,
  EncodingContext? context,
  Map<String, String>? streamOptions,
  bool? enableAudioVbrEncoding = true,
  CancelToken? cancelToken,
  Map<String, dynamic>? headers,
  Map<String, dynamic>? extra,
  ValidateStatus? validateStatus,
  ProgressCallback? onSendProgress,
  ProgressCallback? onReceiveProgress,
}) async {
  final _path = r'/Videos/{itemId}/stream'.replaceAll(
    '{'
    r'itemId'
    '}',
    itemId.toString(),
  );
  final _options = Options(
    method: r'GET',
    responseType: ResponseType.bytes,
    headers: <String, dynamic>{...?headers},
    extra: <String, dynamic>{'secure': <Map<String, String>>[], ...?extra},
    validateStatus: validateStatus,
  );

  final _queryParameters = <String, dynamic>{
    if (container != null) r'container': container,
    if (static_ != null) r'static': static_,
    if (params != null) r'params': params,
    if (tag != null) r'tag': tag,
    if (deviceProfileId != null) r'deviceProfileId': deviceProfileId,
    if (playSessionId != null) r'playSessionId': playSessionId,
    if (segmentContainer != null) r'segmentContainer': segmentContainer,
    if (segmentLength != null) r'segmentLength': segmentLength,
    if (minSegments != null) r'minSegments': minSegments,
    if (mediaSourceId != null) r'mediaSourceId': mediaSourceId,
    if (deviceId != null) r'deviceId': deviceId,
    if (audioCodec != null) r'audioCodec': audioCodec,
    if (enableAutoStreamCopy != null)
      r'enableAutoStreamCopy': enableAutoStreamCopy,
    if (allowVideoStreamCopy != null)
      r'allowVideoStreamCopy': allowVideoStreamCopy,
    if (allowAudioStreamCopy != null)
      r'allowAudioStreamCopy': allowAudioStreamCopy,
    if (breakOnNonKeyFrames != null)
      r'breakOnNonKeyFrames': breakOnNonKeyFrames,
    if (audioSampleRate != null) r'audioSampleRate': audioSampleRate,
    if (maxAudioBitDepth != null) r'maxAudioBitDepth': maxAudioBitDepth,
    if (audioBitRate != null) r'audioBitRate': audioBitRate,
    if (audioChannels != null) r'audioChannels': audioChannels,
    if (maxAudioChannels != null) r'maxAudioChannels': maxAudioChannels,
    if (profile != null) r'profile': profile,
    if (level != null) r'level': level,
    if (framerate != null) r'framerate': framerate,
    if (maxFramerate != null) r'maxFramerate': maxFramerate,
    if (copyTimestamps != null) r'copyTimestamps': copyTimestamps,
    if (startTimeTicks != null) r'startTimeTicks': startTimeTicks,
    if (width != null) r'width': width,
    if (height != null) r'height': height,
    if (maxWidth != null) r'maxWidth': maxWidth,
    if (maxHeight != null) r'maxHeight': maxHeight,
    if (videoBitRate != null) r'videoBitRate': videoBitRate,
    if (subtitleStreamIndex != null)
      r'subtitleStreamIndex': subtitleStreamIndex,
    if (subtitleMethod != null) r'subtitleMethod': subtitleMethod,
    if (maxRefFrames != null) r'maxRefFrames': maxRefFrames,
    if (maxVideoBitDepth != null) r'maxVideoBitDepth': maxVideoBitDepth,
    if (requireAvc != null) r'requireAvc': requireAvc,
    if (deInterlace != null) r'deInterlace': deInterlace,
    if (requireNonAnamorphic != null)
      r'requireNonAnamorphic': requireNonAnamorphic,
    if (transcodingMaxAudioChannels != null)
      r'transcodingMaxAudioChannels': transcodingMaxAudioChannels,
    if (cpuCoreLimit != null) r'cpuCoreLimit': cpuCoreLimit,
    if (liveStreamId != null) r'liveStreamId': liveStreamId,
    if (enableMpegtsM2TsMode != null)
      r'enableMpegtsM2TsMode': enableMpegtsM2TsMode,
    if (videoCodec != null) r'videoCodec': videoCodec,
    if (subtitleCodec != null) r'subtitleCodec': subtitleCodec,
    if (transcodeReasons != null) r'transcodeReasons': transcodeReasons,
    if (audioStreamIndex != null) r'audioStreamIndex': audioStreamIndex,
    if (videoStreamIndex != null) r'videoStreamIndex': videoStreamIndex,
    if (context != null) r'context': context,
    if (streamOptions != null) r'streamOptions': streamOptions,
    if (enableAudioVbrEncoding != null)
      r'enableAudioVbrEncoding': enableAudioVbrEncoding,
  };

  final _response = await _dio.request<Object>(
    _path,
    options: _options,
    queryParameters: _queryParameters,
    cancelToken: cancelToken,
    onSendProgress: onSendProgress,
    onReceiveProgress: onReceiveProgress,
  );

  Uint8List? _responseData;

  try {
    final rawData = _response.data;
    _responseData = rawData == null ? null : rawData as Uint8List;
  } catch (error, stackTrace) {
    throw DioException(
      requestOptions: _response.requestOptions,
      response: _response,
      type: DioExceptionType.unknown,
      error: error,
      stackTrace: stackTrace,
    );
  }

  return Response<Uint8List>(
    data: _responseData,
    headers: _response.headers,
    isRedirect: _response.isRedirect,
    requestOptions: _response.requestOptions,
    redirects: _response.redirects,
    statusCode: _response.statusCode,
    statusMessage: _response.statusMessage,
    extra: _response.extra,
  );
}