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

    Show / Hide Table of Contents

    getArtistsInstantmix

    Creates an instant playlist based on a given artist

    Requires authentication as user

    getArtistsInstantmix

    Request
    get /Artists/InstantMix
    Parameters
    Name In Type Default Notes
    ArtistType query

    Artist or AlbumArtist

    MaxOfficialRating query

    Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).

    HasThemeSong query

    Optional filter by items with theme songs.

    HasThemeVideo query

    Optional filter by items with theme videos.

    HasSubtitles query

    Optional filter by items with subtitles.

    HasSpecialFeature query

    Optional filter by items with special features.

    HasTrailer query

    Optional filter by items with trailers.

    IsSpecialSeason query

    Optional. Filter by special season.

    AdjacentTo query

    Optional. Return items that are siblings of a supplied item.

    StartItemId query

    Optional. Skip through the list until a given item is found.

    MinIndexNumber query

    Optional filter by minimum index number.

    MinStartDate query

    Optional. The minimum premiere date. Format = ISO

    MaxStartDate query

    Optional. The maximum premiere date. Format = ISO

    MinEndDate query

    Optional. The minimum premiere date. Format = ISO

    MaxEndDate query

    Optional. The maximum premiere date. Format = ISO

    MinPlayers query

    Optional filter by minimum number of game players.

    MaxPlayers query

    Optional filter by maximum number of game players.

    ParentIndexNumber query

    Optional filter by parent index number.

    HasParentalRating query

    Optional filter by items that have or do not have a parental rating

    IsHD query

    Optional filter by items that are HD or not.

    IsUnaired query

    Optional filter by items that are unaired episodes or not.

    MinCommunityRating query

    Optional filter by minimum community rating.

    MinCriticRating query

    Optional filter by minimum critic rating.

    AiredDuringSeason query

    Gets all episodes that aired during a season, including specials.

    MinPremiereDate query

    Optional. The minimum premiere date. Format = ISO

    MinDateLastSaved query

    Optional. The minimum premiere date. Format = ISO

    MinDateLastSavedForUser query

    Optional. The minimum premiere date. Format = ISO

    MaxPremiereDate query

    Optional. The maximum premiere date. Format = ISO

    HasOverview query

    Optional filter by items that have an overview or not.

    HasImdbId query

    Optional filter by items that have an imdb id or not.

    HasTmdbId query

    Optional filter by items that have a tmdb id or not.

    HasTvdbId query

    Optional filter by items that have a tvdb id or not.

    ExcludeItemIds query

    Optional. If specified, results will be filtered by exxcluding item ids. This allows multiple, comma delimeted.

    StartIndex query

    Optional. The record index to start at. All items with a lower index will be dropped from the results.

    Limit query

    Optional. The maximum number of records to return

    Recursive query

    When searching within folders, this determines whether or not the search will be recursive. true/false

    SearchTerm query

    Enter a search term to perform a search request

    SortOrder query

    Sort Order - Ascending,Descending

    ParentId query

    Specify this to localize the search to a specific item or folder. Omit to use the root

    Fields query

    Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines

    ExcludeItemTypes query

    Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.

    IncludeItemTypes query

    Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.

    AnyProviderIdEquals query

    Optional. If specified, result will be filtered to contain only items which match at least one of the specified IDs. Each provider ID must be in the form 'prov.id', e.g. 'imdb.tt123456'. This allows multiple, comma delimeted value pairs.

    Filters query

    Optional. Specify additional filters to apply. This allows multiple, comma delimeted. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes

    IsFavorite query

    Optional filter by items that are marked as favorite, or not.

    IsMovie query

    Optional filter for movies.

    IsSeries query

    Optional filter for series.

    IsFolder query

    Optional filter for folders.

    IsNews query

    Optional filter for news.

    IsKids query

    Optional filter for kids.

    IsSports query

    Optional filter for sports.

    IsNew query

    Optional filter for IsNew.

    IsPremiere query

    Optional filter for IsPremiere.

    IsNewOrPremiere query

    Optional filter for IsNewOrPremiere.

    IsRepeat query

    Optional filter for IsRepeat.

    ProjectToMedia query

    ProjectToMedia

    MediaTypes query

    Optional filter by MediaType. Allows multiple, comma delimited.

    ImageTypes query

    Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.

    SortBy query

    Optional. Specify one or more sort orders, comma delimeted. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime

    IsPlayed query

    Optional filter by items that are played, or not.

    Genres query

    Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimeted.

    OfficialRatings query

    Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimeted.

    Tags query

    Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimeted.

    ExcludeTags query

    Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimeted.

    Years query

    Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimeted.

    EnableImages query

    Optional, include image information in output

    EnableUserData query

    Optional, include user data

    ImageTypeLimit query

    Optional, the max number of images to return, per image type

    EnableImageTypes query

    Optional. The image types to include in the output.

    Person query

    Optional. If specified, results will be filtered to include only those containing the specified person.

    PersonIds query

    Optional. If specified, results will be filtered to include only those containing the specified person.

    PersonTypes query

    Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited

    Studios query

    Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimeted.

    StudioIds query

    Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimeted.

    Artists query

    Optional. If specified, results will be filtered based on artist. This allows multiple, pipe delimeted.

    ArtistIds query

    Optional. If specified, results will be filtered based on artist. This allows multiple, pipe delimeted.

    Albums query

    Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimeted.

    Ids query

    Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.

    VideoTypes query

    Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimeted.

    Containers query

    Optional filter by Container. Allows multiple, comma delimeted.

    AudioCodecs query

    Optional filter by AudioCodec. Allows multiple, comma delimeted.

    AudioLayouts query

    Optional filter by AudioLayout. Allows multiple, comma delimeted.

    VideoCodecs query

    Optional filter by VideoCodec. Allows multiple, comma delimeted.

    ExtendedVideoTypes query

    Optional filter by ExtendedVideoType. Allows multiple, comma delimeted.

    SubtitleCodecs query

    Optional filter by SubtitleCodec. Allows multiple, comma delimeted.

    Path query

    Optional filter by Path.

    UserId query

    User Id

    MinOfficialRating query

    Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).

    IsLocked query

    Optional filter by items that are locked.

    IsPlaceHolder query

    Optional filter by items that are placeholders

    HasOfficialRating query

    Optional filter by items that have official ratings

    GroupItemsIntoCollections query

    Whether or not to hide items behind their boxsets.

    Is3D query

    Optional filter by items that are 3D, or not.

    SeriesStatus query

    Optional filter by Series Status. Allows multiple, comma delimeted.

    NameStartsWithOrGreater query

    Optional filter by items whose name is sorted equally or greater than a given input string.

    ArtistStartsWithOrGreater query

    Optional filter by items whose name is sorted equally or greater than a given input string.

    AlbumArtistStartsWithOrGreater query

    Optional filter by items whose name is sorted equally or greater than a given input string.

    NameStartsWith query

    Optional filter by items whose name is sorted equally than a given input string.

    NameLessThan query

    Optional filter by items whose name is equally or lesser than a given input string.

    Responses
    Status Code Type Description Samples
    200 QueryResult_BaseItemDto

    Operation successful. Returning a QueryResult object.

    400

    Bad Request. Server cannot process request.

    401

    Unauthorized. Client needs to authenticate.

    403

    Forbidden. No permission for the reqested operation.

    404

    Resource not found or unavailable.

    500

    Server error.

    Definitions

    QueryResult_BaseItemDto

    QueryResult_BaseItemDto
    Name Type Notes
    Items BaseItemDto[]
    TotalRecordCount integer (int32)

    BaseItemDto

    see also MediaBrowser.Model.Dto.BaseItemDto

    Name Type Notes
    Name string

    The name.

    OriginalTitle string
    ServerId string

    The server identifier.

    Id string

    The id.

    Guid string
    Etag string

    The etag.

    Prefix string

    The Prefix.

    TunerName string
    PlaylistItemId string

    The playlist item identifier.

    DateCreated string (date-time)

    The date created.

    ExtraType string
    SortIndexNumber integer (int32)
    SortParentIndexNumber integer (int32)
    CanDelete boolean
    CanDownload boolean
    CanEditItems boolean
    SupportsResume boolean
    PresentationUniqueKey string
    PreferredMetadataLanguage string
    PreferredMetadataCountryCode string
    SupportsSync boolean

    A value indicating whether [supports synchronize].

    SyncStatus SyncJobItemStatus
    CanManageAccess boolean
    CanLeaveContent boolean
    CanMakePublic boolean
    Container string
    SortName string

    The name of the sort.

    ForcedSortName string
    Video3DFormat Video3DFormat
    PremiereDate string (date-time)

    The premiere date.

    ExternalUrls ExternalUrl[]

    The external urls.

    MediaSources MediaSourceInfo[]

    The media versions.

    CriticRating number (float)

    The critic rating.

    GameSystemId integer (int64)
    AsSeries boolean
    GameSystem string

    The game system.

    ProductionLocations array
    Path string

    The path.

    OfficialRating string

    The official rating.

    CustomRating string

    The custom rating.

    ChannelId string

    The channel identifier.

    ChannelName string
    Overview string

    The overview.

    Taglines array

    The taglines.

    Genres array

    The genres.

    CommunityRating number (float)

    The community rating.

    RunTimeTicks integer (int64)

    The run time ticks.

    Size integer (int64)
    FileName string
    Bitrate integer (int32)
    ProductionYear integer (int32)

    The production year.

    Number string

    The number.

    ChannelNumber string
    IndexNumber integer (int32)

    The index number.

    IndexNumberEnd integer (int32)

    The index number end.

    ParentIndexNumber integer (int32)

    The parent index number.

    RemoteTrailers MediaUrl[]

    The trailer urls.

    ProviderIds ProviderIdDictionary
    IsFolder boolean

    A value indicating whether this instance is folder.

    ParentId string

    The parent id.

    Type string

    The type.

    People BaseItemPerson[]

    The people.

    Studios NameLongIdPair[]

    The studios.

    GenreItems NameLongIdPair[]
    TagItems NameLongIdPair[]
    ParentLogoItemId string

    If the item does not have a logo, this will hold the Id of the Parent that has one.

    ParentBackdropItemId string

    If the item does not have any backdrops, this will hold the Id of the Parent that has one.

    ParentBackdropImageTags array

    The parent backdrop image tags.

    LocalTrailerCount integer (int32)

    The local trailer count.

    UserData UserItemDataDto[]

    Class UserItemDataDto

    RecursiveItemCount integer (int32)

    The recursive item count.

    ChildCount integer (int32)

    The child count.

    SeasonCount integer (int32)
    SeriesName string

    The name of the series.

    SeriesId string

    The series id.

    SeasonId string

    The season identifier.

    SpecialFeatureCount integer (int32)

    The special feature count.

    DisplayPreferencesId string

    The display preferences id.

    Status string

    The status.

    AirDays DayOfWeek[]

    The air days.

    Tags array

    The tags.

    PrimaryImageAspectRatio number (double)

    The primary image aspect ratio, after image enhancements.

    Artists array

    The artists.

    ArtistItems NameIdPair[]

    The artist items.

    Composers NameIdPair[]
    Album string

    The album.

    CollectionType string

    The type of the collection.

    DisplayOrder string

    The display order.

    AlbumId string

    The album id.

    AlbumPrimaryImageTag string

    The album image tag.

    SeriesPrimaryImageTag string

    The series primary image tag.

    AlbumArtist string

    The album artist.

    AlbumArtists NameIdPair[]

    The album artists.

    SeasonName string

    The name of the season.

    MediaStreams MediaStream[]

    The media streams.

    PartCount integer (int32)

    The part count.

    ImageTags object

    The image tags.

    BackdropImageTags array

    The backdrop image tags.

    ParentLogoImageTag string

    The parent logo image tag.

    SeriesStudio string

    The series studio.

    PrimaryImageItemId string
    PrimaryImageTag string
    ParentThumbItemId string

    The parent thumb item id.

    ParentThumbImageTag string

    The parent thumb image tag.

    Chapters ChapterInfo[]

    The chapters.

    LocationType LocationType

    Enum LocationType

    MediaType string

    The type of the media.

    EndDate string (date-time)

    The end date.

    LockedFields MetadataFields[]

    The locked fields.

    LockData boolean

    A value indicating whether [enable internet providers].

    Width integer (int32)
    Height integer (int32)
    CameraMake string
    CameraModel string
    Software string
    ExposureTime number (double)
    FocalLength number (double)
    ImageOrientation ImageOrientation
    Aperture number (double)
    ShutterSpeed number (double)
    Latitude number (double)
    Longitude number (double)
    Altitude number (double)
    IsoSpeedRating integer (int32)
    SeriesTimerId string

    The series timer identifier.

    ChannelPrimaryImageTag string

    The channel primary image tag.

    StartDate string (date-time)

    The start date of the recording, in UTC.

    CompletionPercentage number (double)

    The completion percentage.

    IsRepeat boolean

    A value indicating whether this instance is repeat.

    IsNew boolean
    EpisodeTitle string

    The episode title.

    IsMovie boolean

    A value indicating whether this instance is movie.

    IsSports boolean

    A value indicating whether this instance is sports.

    IsSeries boolean

    A value indicating whether this instance is series.

    IsLive boolean

    A value indicating whether this instance is live.

    IsNews boolean

    A value indicating whether this instance is news.

    IsKids boolean

    A value indicating whether this instance is kids.

    IsPremiere boolean

    A value indicating whether this instance is premiere.

    TimerType TimerType
    Disabled boolean
    ManagementId string
    TimerId string

    The timer identifier.

    CurrentProgram
    MovieCount integer (int32)
    SeriesCount integer (int32)
    AlbumCount integer (int32)
    SongCount integer (int32)
    MusicVideoCount integer (int32)
    Subviews array
    ListingsProviderId string
    ListingsChannelId string
    ListingsPath string
    ListingsId string
    ListingsChannelName string
    ListingsChannelNumber string
    AffiliateCallSign string

    SyncJobItemStatus

    see also MediaBrowser.Model.Sync.SyncJobItemStatus

    Enum Values
    • Queued
    • Converting
    • ReadyToTransfer
    • Transferring
    • Synced
    • Failed

    Video3DFormat

    see also MediaBrowser.Model.Entities.Video3DFormat

    Enum Values
    • HalfSideBySide
    • FullSideBySide
    • FullTopAndBottom
    • HalfTopAndBottom
    • MVC

    ExternalUrl

    see also MediaBrowser.Model.Providers.ExternalUrl

    Name Type Notes
    Name string

    The name.

    Url string

    The type of the item.

    MediaSourceInfo

    see also MediaBrowser.Model.Dto.MediaSourceInfo

    Name Type Notes
    Chapters ChapterInfo[]
    Protocol MediaProtocol
    Id string
    Path string
    EncoderPath string
    EncoderProtocol MediaProtocol
    Type MediaSourceType
    ProbePath string
    ProbeProtocol MediaProtocol
    Container string
    Size integer (int64)
    Name string
    SortName string
    IsRemote boolean

    Differentiate internet url vs local network

    HasMixedProtocols boolean
    RunTimeTicks integer (int64)
    ContainerStartTimeTicks integer (int64)
    SupportsTranscoding boolean
    TrancodeLiveStartIndex integer (int32)
    WallClockStart string (date-time)
    SupportsDirectStream boolean
    SupportsDirectPlay boolean
    IsInfiniteStream boolean
    RequiresOpening boolean
    OpenToken string
    RequiresClosing boolean
    LiveStreamId string
    BufferMs integer (int32)
    RequiresLooping boolean
    SupportsProbing boolean
    Video3DFormat Video3DFormat
    MediaStreams MediaStream[]
    Formats array
    Bitrate integer (int32)
    Timestamp TransportStreamTimestamp
    RequiredHttpHeaders object
    DirectStreamUrl string
    AddApiKeyToDirectStreamUrl boolean
    TranscodingUrl string
    TranscodingSubProtocol string
    TranscodingContainer string
    AnalyzeDurationMs integer (int32)
    ReadAtNativeFramerate boolean
    DefaultAudioStreamIndex integer (int32)
    DefaultSubtitleStreamIndex integer (int32)
    ItemId string

    Used only by our Windows app. Not used by Emby Server. The id of the item that this mediasource belongs to, if there is one Also used by Emby for Kodi

    ServerId string

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

    ChapterInfo

    see also MediaBrowser.Model.Entities.ChapterInfo

    Name Type Notes
    StartPositionTicks integer (int64)

    The start position ticks.

    Name string

    The name.

    ImageTag string
    MarkerType MarkerType
    ChapterIndex integer (int32)

    MarkerType

    see also MediaBrowser.Model.Entities.MarkerType

    Enum Values
    • Chapter
    • IntroStart
    • IntroEnd
    • CreditsStart

    MediaProtocol

    see also MediaBrowser.Model.MediaInfo.MediaProtocol

    Enum Values
    • File
    • Http
    • Rtmp
    • Rtsp
    • Udp
    • Rtp
    • Ftp
    • Mms

    MediaSourceType

    see also MediaBrowser.Model.Dto.MediaSourceType

    Enum Values
    • Default
    • Grouping
    • Placeholder

    MediaStream

    see also MediaBrowser.Model.Entities.MediaStream

    Name Type Notes
    Codec string

    The codec.

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

    CodecTag string

    The codec tag.

    Probe Field: codec_tag
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.

    Language string

    The language.

    Probe Field: tags["language"]
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.

    ColorTransfer string

    The color transfer characteristics.

    Probe Field: color_transfer
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video
    Related Enum: Emby.Media.Model.Enums.ColorTransfers.

    ColorPrimaries string

    The chromaticity coordinates of the source primaries.

    Probe Field: color_primaries
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video
    Related Enum: Emby.Media.Model.Enums.ColorPrimaries.

    ColorSpace string

    The YUV colorspace type.

    Probe Field: color_space
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video
    Related Enum: Emby.Media.Model.Enums.ColorSpaces.

    Comment string

    The comment.

    Probe Field: tags["comment"]
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.

    StreamStartTimeTicks integer (int64)

    The start time of the stream.

    Probe Field: start_time
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.
    Actual type: System.TimeSpan.

    TimeBase string

    The time-base.

    Probe Field: time_base
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.
    Actual type: Emby.Media.Model.Types.Rational.

    Title string

    The title.

    Probe Field: tags["title"]
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.

    Extradata string

    The extradata.

    Probe Field: extradata
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.

    Currently, this value is only parsed for subtitle streams with codec Emby.Media.Model.Enums.SubtitleMediaTypes.dvb_teletext.

    VideoRange string
    DisplayTitle string

    The display title.

    Custom property set by the application.

    DisplayLanguage string

    The display language.

    Custom property set by the application.

    NalLengthSize string

    The nal length size.

    Probe Field: nal_length_size
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video of type Emby.Media.Model.Enums.VideoMediaTypes.h264.
    Actual type: System.Int32.

    IsInterlaced boolean

    A value indicating whether this instance is interlaced.

    Probe Field: field_order != progressive
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.

    IsAVC boolean
    ChannelLayout string

    The channel layout.

    Probe Field: channel_layout
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Audio
    Related Enum: MediaBrowser.Model.Entities.MediaStream.ChannelLayout.

    BitRate integer (int32)

    The bit rate.

    Probe Field: bit_rate
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio.

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

    BitDepth integer (int32)

    The bit depth.

    Probe Field: bits_per_sample or bits_per_raw_sample
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio.

    RefFrames integer (int32)

    The reference frames.

    Probe Field: refs
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.

    Rotation integer (int32)
    Channels integer (int32)

    The audio channel count.

    Probe Field: channels
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Audio.

    SampleRate integer (int32)

    The sample rate.

    Probe Field: sample_rate
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Audio
    Related Enum: Emby.Media.Model.Enums.SampleRates.

    IsDefault boolean

    A value indicating whether this instance is default.

    Probe Field: disposition["default"]
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.

    IsForced boolean

    A value indicating whether this instance is forced.

    Probe Field: disposition["forced"]
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.

    IsHearingImpaired boolean
    Height integer (int32)

    The height.

    Probe Field: height
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.

    Width integer (int32)

    The width.

    Probe Field: width
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.

    AverageFrameRate number (float)

    The average frame rate..

    Probe Field: avg_frame_rate
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.
    Actual type: Emby.Media.Model.Types.Rational.

    RealFrameRate number (float)

    The real frame rate..

    Probe Field: r_frame_rate
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.
    Actual type: Emby.Media.Model.Types.Rational.

    Profile string

    The profile.

    Probe Field: profile
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio
    Related Enums: Emby.Media.Model.Enums.AacProfiles, Emby.Media.Model.Enums.AvcProfiles, Emby.Media.Model.Enums.H263Profiles, Emby.Media.Model.Enums.HevcProfiles, Emby.Media.Model.Enums.Mpeg2Profiles,Emby.Media.Model.Enums.Vc1Profiles, Emby.Media.Model.Enums.Mpeg4Profiles, Emby.Media.Model.Enums.Vp8Profiles, Emby.Media.Model.Enums.Vp9Profiles.

    Type MediaStreamType

    Enum MediaStreamType

    AspectRatio string

    The aspect ratio.

    Probe Field: display_aspect_ratio
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.
    Actual type: Emby.Media.Model.Types.Rational.

    Index integer (int32)

    The index of the stream inside its container.

    Probe Field: index
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.

    IsExternal boolean

    A value indicating whether this instance is external.

    Custom property set by the application.

    DeliveryMethod SubtitleDeliveryMethod
    DeliveryUrl string

    The delivery URL.

    Custom property set by the application.

    IsExternalUrl boolean

    A value indicating whether this instance is external URL.

    Custom property set by the application.

    IsTextSubtitleStream boolean
    SupportsExternalStream boolean

    A value indicating whether [supports external stream].

    Path string

    The filename.

    Protocol MediaProtocol
    PixelFormat string

    The pixel format.

    Probe Field: pix_fmt
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.
    Actual type: MediaBrowser.Model.Entities.MediaStream.PixelFormat.

    Level number (double)

    The codec level.

    Probe Field: level
    Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video
    Related Enums: Emby.Media.Model.Enums.AvcLevels, Emby.Media.Model.Enums.H263Levels, Emby.Media.Model.Enums.HevcLevels, Emby.Media.Model.Enums.Mpeg2Levels,Emby.Media.Model.Enums.Vc1Levels, Emby.Media.Model.Enums.Mpeg4Levels, Emby.Media.Model.Enums.Vp8Levels, Emby.Media.Model.Enums.Vp9Levels.

    IsAnamorphic boolean

    A value indicating whether this instance is anamorphic.

    ExtendedVideoType ExtendedVideoTypes
    ExtendedVideoSubType ExtendedVideoSubTypes
    ExtendedVideoSubTypeDescription string

    The extended video sub-type description.

    ItemId string

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

    ServerId string

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

    AttachmentSize integer (int32)

    The size of the attachment.

    MimeType string

    The type of the MIME.

    SubtitleLocationType SubtitleLocationType

    MediaStreamType

    see also MediaBrowser.Model.Entities.MediaStreamType

    Enum Values
    • Unknown
    • Audio
    • Video
    • Subtitle
    • EmbeddedImage
    • Attachment
    • Data

    SubtitleDeliveryMethod

    see also MediaBrowser.Model.Dlna.SubtitleDeliveryMethod

    Enum Values
    • Encode
    • Embed
    • External
    • Hls
    • VideoSideData

    ExtendedVideoTypes

    see also MediaBrowser.Model.Entities.ExtendedVideoTypes

    Enum Values
    • None
    • Hdr10
    • Hdr10Plus
    • HyperLogGamma
    • DolbyVision

    ExtendedVideoSubTypes

    see also MediaBrowser.Model.Entities.ExtendedVideoSubTypes

    Enum Values
    • None
    • Hdr10
    • HyperLogGamma
    • Hdr10Plus0
    • DoviProfile02
    • DoviProfile10
    • DoviProfile22
    • DoviProfile30
    • DoviProfile42
    • DoviProfile50
    • DoviProfile61
    • DoviProfile76
    • DoviProfile81
    • DoviProfile82
    • DoviProfile83
    • DoviProfile84
    • DoviProfile85
    • DoviProfile92

    SubtitleLocationType

    see also MediaBrowser.Model.Entities.SubtitleLocationType

    Enum Values
    • InternalStream
    • VideoSideData

    TransportStreamTimestamp

    see also MediaBrowser.Model.MediaInfo.TransportStreamTimestamp

    Enum Values
    • None
    • Zero
    • Valid

    MediaUrl

    see also MediaBrowser.Model.Entities.MediaUrl

    Name Type Notes
    Url string
    Name string

    ProviderIdDictionary

    see also MediaBrowser.Model.Entities.ProviderIdDictionary

    BaseItemPerson

    see also MediaBrowser.Model.Dto.BaseItemPerson

    Name Type Notes
    Name string

    The name.

    Id string

    The identifier.

    Role string

    The role.

    Type PersonType
    PrimaryImageTag string

    The primary image tag.

    PersonType

    see also MediaBrowser.Model.Entities.PersonType

    Enum Values
    • Actor
    • Director
    • Writer
    • Producer
    • GuestStar
    • Composer
    • Conductor
    • Lyricist

    NameLongIdPair

    see also MediaBrowser.Model.Dto.NameLongIdPair

    Name Type Notes
    Name string

    The name.

    Id integer (int64)

    The identifier.

    UserItemDataDto

    see also MediaBrowser.Model.Dto.UserItemDataDto

    Name Type Notes
    Rating number (double)

    The rating.

    PlayedPercentage number (double)

    The played percentage.

    UnplayedItemCount integer (int32)

    The unplayed item count.

    PlaybackPositionTicks integer (int64)

    The playback position ticks.

    PlayCount integer (int32)

    The play count.

    IsFavorite boolean

    A value indicating whether this instance is favorite.

    LastPlayedDate string (date-time)

    The last played date.

    Played boolean

    A value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is played.

    Key string

    The key.

    ItemId string

    The item identifier.

    ServerId string

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

    DayOfWeek

    System.DayOfWeek

    NameIdPair

    see also MediaBrowser.Model.Dto.NameIdPair

    Name Type Notes
    Name string

    The name.

    Id string

    The identifier.

    LocationType

    see also MediaBrowser.Model.Entities.LocationType

    Enum Values
    • FileSystem
    • Virtual

    MetadataFields

    see also MediaBrowser.Model.Entities.MetadataFields

    ImageOrientation

    see also MediaBrowser.Model.Drawing.ImageOrientation

    Enum Values
    • TopLeft
    • TopRight
    • BottomRight
    • BottomLeft
    • LeftTop
    • RightTop
    • RightBottom
    • LeftBottom

    TimerType

    see also MediaBrowser.Model.LiveTv.TimerType

    Enum Values
    • Program
    • DateTime
    • Keyword
    SDK
    On this Page
    Back to Top Copyright 2022 © EMBY LLC. Please see our terms of use and privacy policy.