Seitenhierarchie

  Wiki Navigation

    Loading...


 Recently Updated


 Latest Releases

 MediaPortal 1.32
            Releasenews | Download
 MediaPortal 2.5
            Releasenews | Download


This page contains the API documentation for this MPExtended service, as automatically generated on 18 Sep 2012 19:45 for version 0.5.0.0 (build 0.4.99.0). Please do not edit, as your changes will be overwritten.

Navigation

General

Control

Stream info

Profiles

Images

Misc

General

AuthorizeRemoteHostForStreaming

URL /json/AuthorizeRemoteHostForStreaming Parameters

  • host (string) Returns WebBoolResult
  • Result (bool)

AuthorizeStreaming

URL /json/AuthorizeStreaming Parameters none Returns WebBoolResult

  • Result (bool)

GetItemSupportStatus

URL /json/GetItemSupportStatus Parameters

  • type (WebMediaType)
  • provider (nullable int)
  • itemId (string) Returns WebItemSupportStatus
  • Supported (bool)
  • Reason (string)

GetMediaItem

URL /stream/GetMediaItem Parameters

  • clientDescription (string)
  • type (WebMediaType)
  • provider (nullable int)
  • itemId (string)
  • startPosition (nullable long) Returns Raw data

GetServiceDescription

URL /json/GetServiceDescription Parameters none Returns WebStreamServiceDescription

  • SupportsMedia (bool)
  • SupportsRecordings (bool)
  • SupportsTV (bool)
  • ApiVersion (int)
  • ServiceVersion (string)

GetStreamingSessions

URL /json/GetStreamingSessions Parameters none Returns List of WebStreamingSession

  • Profile (string)
  • Identifier (string)
  • SourceType (WebMediaType):
  • SourceId (string)
  • DisplayName (string)
  • ClientDescription (string)
  • ClientIPAddress (string)
  • StartTime (DateTime)
  • StartPosition (long)
  • PlayerPosition (long)
  • PercentageProgress (int)
  • TranscodingInfo (WebTranscodingInfo):
    • TranscodedTime (long)
    • TranscodedFrames (long)
    • TranscodingPosition (long)
    • TranscodingFPS (long)
    • OutputBitrate (long)
    • Supported (bool)
    • Finished (bool)
    • Failed (bool)

Control

DoStream

URL /stream/DoStream Parameters

  • type (WebMediaType)
  • provider (nullable int)
  • itemId (string)
  • clientDescription (string)
  • profileName (string)
  • startPosition (long)
  • idleTimeout (nullable int) Returns Raw data

FinishStream

URL /json/FinishStream Parameters

  • identifier (string) Returns WebBoolResult
  • Result (bool)

InitStream

URL /json/InitStream Parameters

  • type (WebMediaType)
  • provider (nullable int)
  • itemId (string)
  • clientDescription (string)
  • identifier (string)
  • idleTimeout (nullable int) Returns WebBoolResult
  • Result (bool)

RetrieveStream

URL /stream/RetrieveStream Parameters

  • identifier (string) Returns Raw data

StartStream

URL /json/StartStream Parameters

  • identifier (string)
  • profileName (string)
  • startPosition (long) Returns WebStringResult
  • Result (string)

StartStreamWithStreamSelection

URL /json/StartStreamWithStreamSelection Parameters

  • identifier (string)
  • profileName (string)
  • startPosition (long)
  • audioId (int)
  • subtitleId (int) Returns WebStringResult
  • Result (string)

StopStream

URL /json/StopStream Parameters

  • identifier (string) Returns WebBoolResult
  • Result (bool)

Stream info

GetMediaInfo

URL /json/GetMediaInfo Parameters

  • type (WebMediaType)
  • provider (nullable int)
  • itemId (string) Returns WebMediaInfo
  • Duration (long)
  • Container (string)
  • VideoStreams (list of WebVideoStream):
    • Codec (string)
    • DisplayAspectRatio (float)
    • DisplayAspectRatioString (string)
    • Width (int)
    • Height (int)
    • ID (int)
    • Index (int)
  • AudioStreams (list of WebAudioStream):
    • Language (string)
    • LanguageFull (string)
    • Channels (int)
    • Codec (string)
    • Title (string)
    • ID (int)
    • Index (int)
  • SubtitleStreams (list of WebSubtitleStream):
    • Language (string)
    • LanguageFull (string)
    • ID (int)
    • Index (int)
    • Filename (string)

GetStreamSize

URL /json/GetStreamSize Parameters

  • type (WebMediaType)
  • provider (nullable int)
  • itemId (string)
  • profile (string) Returns WebResolution
  • Width (int)
  • Height (int)

GetTranscodingInfo

URL /json/GetTranscodingInfo Parameters

  • identifier (string)
  • playerPosition (nullable long) Returns WebTranscodingInfo
  • TranscodedTime (long)
  • TranscodedFrames (long)
  • TranscodingPosition (long)
  • TranscodingFPS (long)
  • OutputBitrate (long)
  • Supported (bool)
  • Finished (bool)
  • Failed (bool)

Profiles

GetTranscoderProfileByName

URL /json/GetTranscoderProfileByName Parameters

  • name (string) Returns WebTranscoderProfile
  • Name (string)
  • Description (string)
  • HasVideoStream (bool)
  • MIME (string)
  • MaxOutputWidth (int)
  • MaxOutputHeight (int)
  • Targets (list of string)
  • Bandwidth (int)
  • Transport (string)

GetTranscoderProfiles

URL /json/GetTranscoderProfiles Parameters none Returns List of WebTranscoderProfile

  • Name (string)
  • Description (string)
  • HasVideoStream (bool)
  • MIME (string)
  • MaxOutputWidth (int)
  • MaxOutputHeight (int)
  • Targets (list of string)
  • Bandwidth (int)
  • Transport (string)

GetTranscoderProfilesForTarget

URL /json/GetTranscoderProfilesForTarget Parameters

  • target (string) Returns List of WebTranscoderProfile
  • Name (string)
  • Description (string)
  • HasVideoStream (bool)
  • MIME (string)
  • MaxOutputWidth (int)
  • MaxOutputHeight (int)
  • Targets (list of string)
  • Bandwidth (int)
  • Transport (string)

Images

ExtractImage

URL /stream/ExtractImage Parameters

  • type (WebMediaType)
  • provider (nullable int)
  • itemId (string)
  • position (long) Returns Raw data

ExtractImageResized

URL /stream/ExtractImageResized Parameters

  • type (WebMediaType)
  • provider (nullable int)
  • itemId (string)
  • position (long)
  • maxWidth (int)
  • maxHeight (int) Returns Raw data

GetArtwork

URL /stream/GetArtwork Parameters

  • mediatype (WebMediaType)
  • provider (nullable int)
  • id (string)
  • artworktype (WebFileType)
  • offset (int) Returns Raw data

GetArtworkResized

URL /stream/GetArtworkResized Parameters

  • mediatype (WebMediaType)
  • provider (nullable int)
  • id (string)
  • artworktype (WebFileType)
  • offset (int)
  • maxWidth (int)
  • maxHeight (int)
  • borders (nullable string) Returns Raw data

GetImage

URL /stream/GetImage Parameters

  • type (WebMediaType)
  • provider (nullable int)
  • id (string) Returns Raw data

GetImageResized

URL /stream/GetImageResized Parameters

  • type (WebMediaType)
  • provider (nullable int)
  • id (string)
  • maxWidth (int)
  • maxHeight (int)
  • borders (nullable string) Returns Raw data

Misc

CustomTranscoderData

URL /stream/CustomTranscoderData Parameters

  • identifier (string)
  • action (string)
  • parameters (string) Returns Raw data

   

 

This page has no comments.