Facebook
Twitter
Pinterest
Tumblr
GitHub
RSS
  • DEV Home
  • Documentation
  • Reference
  • Download
Search Results for

    Show / Hide Table of Contents

    Class MediaStream

    MediaStream information.

    Inheritance
    System.Object
    MediaStream
    Namespace: MediaBrowser.Model.Entities
    Assembly: MediaBrowser.Model.dll
    Syntax
    public class MediaStream
    Remarks

    MediaStream itens are typically included in a MediaSourceInfo object.

    Properties

    AspectRatio

    Gets or sets the aspect ratio.

    Probe Field: display_aspect_ratio
    Applies to: Video.
    Actual type: Rational.

    Declaration
    public string AspectRatio { get; set; }
    Property Value
    Type Description
    System.String

    The aspect ratio as string.

    AttachmentSize

    Gets or sets the size of the attachment.

    Declaration
    public int? AttachmentSize { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    The size of the attachment.

    AverageFrameRate

    Gets or sets the average frame rate..

    Probe Field: avg_frame_rate
    Applies to: Video.
    Actual type: Rational.

    Declaration
    public float? AverageFrameRate { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Single>

    The average frame rate as float.

    BitDepth

    Gets or sets the bit depth.

    Probe Field: bits_per_sample or bits_per_raw_sample
    Applies to: Video, Audio.

    Declaration
    public int? BitDepth { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    The bit depth.

    BitRate

    Gets or sets the bit rate.

    Probe Field: bit_rate
    Applies to: Video, Audio.

    Declaration
    public int? BitRate { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    The bit rate.

    Remarks

    THIS VALUE IS PROCESSED BY CUSTOM LOGIC AND DOES NOT NECESSARILY MATCH FFPROBE RESULTS!

    ChannelLayout

    Gets or sets the channel layout.

    Probe Field: channel_layout
    Applies to: Audio
    Related Enum: ChannelLayout.

    Declaration
    public string ChannelLayout { get; set; }
    Property Value
    Type Description
    System.String

    The channel layout string.

    Channels

    Gets or sets the audio channel count.

    Probe Field: channels
    Applies to: Audio.

    Declaration
    public int? Channels { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    The audio channel count.

    Codec

    Gets or sets the codec.

    Probe Field: codec_name
    Applies to: Video, Audio, Subtitle
    Related Enums: T:Emby.Media.Model.Enums.VideoMediaTypes, AudioMediaTypes, SubtitleMediaTypes.

    Declaration
    public string Codec { get; set; }
    Property Value
    Type Description
    System.String

    The codec tag.

    CodecTag

    Gets or sets the codec tag.

    Probe Field: codec_tag
    Applies to: Video, Audio, Subtitle.

    Declaration
    public string CodecTag { get; set; }
    Property Value
    Type Description
    System.String

    The codec tag.

    ColorPrimaries

    Gets or sets the chromaticity coordinates of the source primaries.

    Probe Field: color_primaries
    Applies to: Video
    Related Enum: ColorPrimaries.

    Declaration
    public string ColorPrimaries { get; set; }
    Property Value
    Type Description
    System.String

    The chromaticity coordinates of the source primaries as string.

    ColorSpace

    Gets or sets the YUV colorspace type.

    Probe Field: color_space
    Applies to: Video
    Related Enum: ColorSpaces.

    Declaration
    public string ColorSpace { get; set; }
    Property Value
    Type Description
    System.String

    The YUV colorspace type as string.

    ColorTransfer

    Gets or sets the color transfer characteristics.

    Probe Field: color_transfer
    Applies to: Video
    Related Enum: ColorTransfers.

    Declaration
    public string ColorTransfer { get; set; }
    Property Value
    Type Description
    System.String

    The color transfer characteristics value as string.

    Comment

    Gets or sets the comment.

    Probe Field: tags["comment"]
    Applies to: Video, Audio, Subtitle.

    Declaration
    public string Comment { get; set; }
    Property Value
    Type Description
    System.String

    The comment.

    DeliveryMethod

    Gets or sets the method.

    Declaration
    public SubtitleDeliveryMethod? DeliveryMethod { get; set; }
    Property Value
    Type Description
    System.Nullable<SubtitleDeliveryMethod>

    The method.

    Remarks

    Custom property set by the application.

    DeliveryUrl

    Gets or sets the delivery URL.

    Declaration
    public string DeliveryUrl { get; set; }
    Property Value
    Type Description
    System.String

    The delivery URL.

    Remarks

    Custom property set by the application.

    DisplayLanguage

    Gets or sets the display language.

    Declaration
    public string DisplayLanguage { get; set; }
    Property Value
    Type Description
    System.String

    The display language.

    Remarks

    Custom property set by the application.

    DisplayTitle

    Gets or sets the display title.

    Declaration
    public string DisplayTitle { get; set; }
    Property Value
    Type Description
    System.String

    The display title.

    Remarks

    Custom property set by the application.

    ExtendedVideoSubType

    Gets or sets the extended video sub-type.

    Declaration
    public ExtendedVideoSubTypes ExtendedVideoSubType { get; set; }
    Property Value
    Type Description
    ExtendedVideoSubTypes

    The the extended video sub-type.

    ExtendedVideoSubTypeDescription

    Gets or sets the extended video sub-type description.

    Declaration
    public string ExtendedVideoSubTypeDescription { get; }
    Property Value
    Type Description
    System.String

    The the extended video sub-type description.

    ExtendedVideoType

    Gets or sets the extended video type.

    Declaration
    public ExtendedVideoTypes ExtendedVideoType { get; set; }
    Property Value
    Type Description
    ExtendedVideoTypes

    The the extended video type.

    Extradata

    Gets or sets the extradata.

    Probe Field: extradata
    Applies to: Video, Audio, Subtitle.

    Declaration
    public string Extradata { get; set; }
    Property Value
    Type Description
    System.String

    The codec extradata as string.

    Remarks

    Currently, this value is only parsed for subtitle streams with codec dvb_teletext.

    Height

    Gets or sets the height.

    Probe Field: height
    Applies to: Video.

    Declaration
    public int? Height { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    The height.

    Index

    Gets or sets the index of the stream inside its container.

    Probe Field: index
    Applies to: Video, Audio, Subtitle.

    Declaration
    public int Index { get; set; }
    Property Value
    Type Description
    System.Int32

    The index of the stream.

    IsAnamorphic

    Gets a value indicating whether this instance is anamorphic.

    Declaration
    public bool? IsAnamorphic { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>

    true if this instance is anamorphic; otherwise, false.

    IsAVC

    Gets or sets the IsAVC property.

    Declaration
    [Obsolete]
    public bool? IsAVC { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>

    The IsAVC property.

    Remarks

    This is redundant. AVC means H264 codec.

    IsClosedCaptions

    Declaration
    [IgnoreDataMember]
    public bool IsClosedCaptions { get; }
    Property Value
    Type Description
    System.Boolean

    IsDefault

    Gets or sets a value indicating whether this instance is default.

    Probe Field: disposition["default"]
    Applies to: Video, Audio, Subtitle.

    Declaration
    public bool IsDefault { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if this instance is default; otherwise, false.

    IsExternal

    Gets or sets a value indicating whether this instance is external.

    Declaration
    public bool IsExternal { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if this instance is external; otherwise, false.

    Remarks

    Custom property set by the application.

    IsExternalUrl

    Gets or sets a value indicating whether this instance is external URL.

    Declaration
    public bool? IsExternalUrl { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>

    null if [is external URL] contains no value, true if [is external URL]; otherwise, false.

    Remarks

    Custom property set by the application.

    IsForced

    Gets or sets a value indicating whether this instance is forced.

    Probe Field: disposition["forced"]
    Applies to: Video, Audio, Subtitle.

    Declaration
    public bool IsForced { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if this instance is forced; otherwise, false.

    IsHearingImpaired

    Declaration
    public bool IsHearingImpaired { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsInterlaced

    Gets or sets a value indicating whether this instance is interlaced.

    Probe Field: field_order != progressive
    Applies to: Video.

    Declaration
    public bool IsInterlaced { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if this instance is interlaced; otherwise, false.

    IsTextSubtitleStream

    Declaration
    public bool IsTextSubtitleStream { get; }
    Property Value
    Type Description
    System.Boolean

    ItemId

    Used only by our Windows app. Not used by Emby Server.

    Declaration
    public string ItemId { get; set; }
    Property Value
    Type Description
    System.String

    Language

    Gets or sets the language.

    Probe Field: tags["language"]
    Applies to: Audio, Subtitle.

    Declaration
    public string Language { get; set; }
    Property Value
    Type Description
    System.String

    The language.

    Level

    Gets or sets the codec level.

    Probe Field: level
    Applies to: Video
    Related Enums: AvcLevels, H263Levels, HevcLevels, Mpeg2Levels, Vc1Levels, Mpeg4Levels, Vp8Levels, Vp9Levels.

    Declaration
    public double? Level { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Double>

    The codec level as string.

    MimeType

    Gets or sets the type of the MIME.

    Declaration
    public string MimeType { get; set; }
    Property Value
    Type Description
    System.String

    The type of the MIME.

    NalLengthSize

    Gets or sets the nal length size.

    Probe Field: nal_length_size
    Applies to: Video of type h264.
    Actual type: System.Int32.

    Declaration
    public string NalLengthSize { get; set; }
    Property Value
    Type Description
    System.String

    The nal length size as string.

    Path

    Gets or sets the filename.

    Declaration
    public string Path { get; set; }
    Property Value
    Type Description
    System.String

    The filename.

    PixelFormat

    Gets or sets the pixel format.

    Probe Field: pix_fmt
    Applies to: Video.
    Actual type: PixelFormat.

    Declaration
    public string PixelFormat { get; set; }
    Property Value
    Type Description
    System.String

    The pixel format as string.

    Profile

    Gets or sets the profile.

    Probe Field: profile
    Applies to: Video, Audio
    Related Enums: AacProfiles, AvcProfiles, H263Profiles, HevcProfiles, Mpeg2Profiles, Vc1Profiles, Mpeg4Profiles, Vp8Profiles, Vp9Profiles.

    Declaration
    public string Profile { get; set; }
    Property Value
    Type Description
    System.String

    The profile as string.

    Protocol

    Declaration
    public MediaProtocol Protocol { get; set; }
    Property Value
    Type Description
    MediaProtocol

    RealFrameRate

    Gets or sets the real frame rate..

    Probe Field: r_frame_rate
    Applies to: Video.
    Actual type: Rational.

    Declaration
    public float? RealFrameRate { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Single>

    The real frame rate as float.

    RefFrames

    Gets or sets the reference frames.

    Probe Field: refs
    Applies to: Video.

    Declaration
    public int? RefFrames { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    The reference frames.

    Rotation

    Declaration
    public int? Rotation { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    SampleRate

    Gets or sets the sample rate.

    Probe Field: sample_rate
    Applies to: Audio
    Related Enum: SampleRates.

    Declaration
    public int? SampleRate { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    The sample rate as string.

    SaneRealFrameRate

    Declaration
    [IgnoreDataMember]
    public float? SaneRealFrameRate { get; }
    Property Value
    Type Description
    System.Nullable<System.Single>

    ServerId

    Used only by our Windows app. Not used by Emby Server.

    Declaration
    public string ServerId { get; set; }
    Property Value
    Type Description
    System.String

    StreamStartTimeTicks

    Gets or sets the start time of the stream.

    Probe Field: start_time
    Applies to: Video, Audio, Subtitle.
    Actual type: System.TimeSpan.

    Declaration
    public long? StreamStartTimeTicks { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int64>

    The start time of the stream as ticks.

    SubtitleLocationType

    Declaration
    public SubtitleLocationType? SubtitleLocationType { get; }
    Property Value
    Type Description
    System.Nullable<SubtitleLocationType>

    SupportsExternalStream

    Gets or sets a value indicating whether [supports external stream].

    Declaration
    public bool SupportsExternalStream { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if [supports external stream]; otherwise, false.

    TimeBase

    Gets or sets the time-base.

    Probe Field: time_base
    Applies to: Video, Audio, Subtitle.
    Actual type: Rational.

    Declaration
    public string TimeBase { get; set; }
    Property Value
    Type Description
    System.String

    The time-base as string.

    Title

    Gets or sets the title.

    Probe Field: tags["title"]
    Applies to: Video, Audio, Subtitle.

    Declaration
    public string Title { get; set; }
    Property Value
    Type Description
    System.String

    The title.

    Type

    Gets or sets the stream type.

    Probe Field: codec_type
    Applies to: Video, Audio, Subtitle, Attachment
    Related Enums: MediaStreamType.

    Declaration
    public MediaStreamType Type { get; set; }
    Property Value
    Type Description
    MediaStreamType

    The stream type as string.

    VideoRange

    Declaration
    public string VideoRange { get; }
    Property Value
    Type Description
    System.String

    Width

    Gets or sets the width.

    Probe Field: width
    Applies to: Video.

    Declaration
    public int? Width { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    The width.

    Methods

    GenerateVideoRange(Boolean)

    Declaration
    public string GenerateVideoRange(bool isForDisplay)
    Parameters
    Type Name Description
    System.Boolean isForDisplay
    Returns
    Type Description
    System.String

    IsTextFormat(ReadOnlySpan<Char>)

    Declaration
    public static bool IsTextFormat(ReadOnlySpan<char> codec)
    Parameters
    Type Name Description
    System.ReadOnlySpan<System.Char> codec
    Returns
    Type Description
    System.Boolean

    IsTextFormat(String)

    Declaration
    public static bool IsTextFormat(string codec)
    Parameters
    Type Name Description
    System.String codec
    Returns
    Type Description
    System.Boolean

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String

    A string that represents the current object.

    Overrides
    System.Object.ToString()

    Extension Methods

    Extensions.JsonClone<T>(T, IJsonSerializer)
    MediaStreamExtensions.AsBaseStream(MediaStream)
    MediaStreamExtensions.AsVideoStream(MediaStream)
    MediaStreamExtensions.AsAudioStream(MediaStream)
    MediaStreamExtensions.AsSubtitleStream(MediaStream)
    MediaStreamExtensions.AsAttachmentStream(MediaStream)
    MediaStreamExtensions.GetSize(MediaStream)

    See Also

    MediaStreams
    SDK
    On this Page
    Back to Top Copyright 2022 © EMBY LLC. Please see our terms of use and privacy policy.