Parameter |
Description |
Values |
Default |
Set by |
Read by |
_ |
Prefix of parameters that shouldn't be altered directly from outside. |
- |
- |
- |
- |
_ActiveAudioStream |
The pid of the currently active audio stream. |
0 - XXX |
- |
The audio selector element. |
- |
_ActiveProgram |
The program number of the currently active program. |
0 - XXX |
- |
The program selector element. |
- |
_ActiveSubtitleStream |
The pid of the currently active subtitle stream. |
0 - XXX |
- |
The subtitle selector element. |
- |
_ActiveTeletextStream |
The pid of the currently active teletext stream. |
0 - XXX |
- |
The teletext vbi element. |
- |
_ActiveVideoStream |
The pid of the currently active video stream. |
0 - XXX |
- |
The video selector element. |
- |
_ActiveVideoStreamResolution |
The active video stream resolution is stored in this parameter. If unknown the parameter is empty. If known the parameter value is specified as "w=\,h=\" where \ and \ are unsigned integer values. |
XML data |
- |
Video sink element or video controller element. |
- |
AnalogCopyProtection |
The value of analog copy protection level |
Integer |
- |
LatensDaemon |
- |
_AnalogInputSignalState |
The Analog input signal present state |
lost, present |
- |
TAnalogDvrSourceElement |
- |
AppBlankVideo |
|
- |
- |
- |
- |
AudioCodecType |
This parameter contains the audio codec type. |
A string. |
- |
Application |
- |
_AudioDecoderInfo |
Decoder specific Information an audio stream. The pid of the stream should be added at the end of the parameter name. |
see TMetaAudioDecoderInfo |
- |
AudioController |
TS Audio Stream Info Decoder HW |
AudioDecoderState |
The audiodecoder can either be in a ready state or awaiting configuration. |
ready, stopped |
- |
TAudioDecoderControllerElement |
- |
AudioEncodingPriorityList |
Priority list for automatic audio encoding selection |
comma separated list of encodings |
- |
MediaPlayer |
- |
AudioLanguageAutomaticSelection |
Used for enable or disable automatic audio audio language selection |
Boolean ("true"/"false") |
- |
MediaPlayer (reading from infobroker) |
- |
AudioLanguagePriorityList |
Priority list for automatic audio language selection |
comma separated list of language codes |
- |
MediaPlayer |
- |
AudioSamplingFreq |
This parameter contains the audio sampling frequency. |
A string. |
- |
Application |
- |
_AudioStreamInfo. |
Information about an audio stream. The pid of the stream should be added at the end of the parameter name. |
XML data (see TMetaAudioStreamInfo) |
- |
Audio stream info decoder element. |
- |
_AudioStreamList |
List of pids of audio streams (in the current program). |
XML data (see TMetaStreamList) |
- |
Audio stream info decoder element. |
- |
AudioTypePriorityList |
Priority list for automatic audio mode selection |
comma separated list of audio mode |
- |
MediaPlayer |
- |
STBID |
This parameter is used for communication with a Bitband VOD server. It represents the client ID in the RTSP setup message. |
A string |
- |
URI or by using SetParameter() |
- |
BlankVideo |
The AVI Parameter among File Source, AVI and Payload Sink Elements. |
A string. |
- |
AVI Element. |
- |
_BufferOverrunErrorCount |
This parameter shows how many times undesired prebuffering has been performed when processing a stream. This happens when the buffer becomes full and can be used to indicate streamer disturbances visible to the user. |
0 - XXX |
- |
Streamer Core |
- |
_BufferRequirement |
This parameter holds the source buffer requirement. |
0 - XXX bytes |
- |
Streamer Core |
- |
_BufferUnderrunErrorCount |
This parameter shows how many times undesired prebuffering has been performed when processing a stream. This happens when the buffer becomes empty and can be used to indicate streamer disturbances visible to the user. |
0 - XXX |
- |
Streamer Core |
- |
bufsize |
Specifies the size (kB) of the media buffer to use. For very high bitrate streams the default value may not be enough. If less buffering is required, this can be lowered to free up memory for other tasks. |
512 - 4096 kB |
2048 kB |
Streamer config, URI |
- |
buftime |
This parameter is used to change how much data (ms) to buffer before starting to play a non H.264 stream.If the value is set too low there is a risk that the buffers might be emptied because of network lag (this will cause the service to once again buffer up data again). If the value is set too high, on the other hand, the buffer might be filled too much giving a similar effect. Also the higher the value is set the longer it takes to start playing a stream, e.g. when switching TV channels. |
0 - 3000 ms |
500 ms |
Streamer config, URI |
- |
Cgmsa |
Indicates if CGMSA copy protection is enabled or not. |
true, false |
- |
MediaPlayer |
- |
ClosedCaptioning |
Indicates if closed captioning is enabled or not. |
true, false |
- |
MediaPlayer |
- |
closedCaptionChannel |
Channel for Closed Captions. NOTE! Only available for VIP1200. |
1 - 8 |
1 |
Streamer config, URI |
- |
closedCaptionMode |
Set the Closed Captioning data mode. Valid values are 608 for EIA-608 captions (VIP1200/VIP1900), 708 for EIA-708 captions (VIP1200) and disable to disable Closed Captions. |
608, 708, disable |
disable |
Streamer config, URI |
- |
closedCaptionOverlay |
When this parameter is true Closed Captions will be rendered on the video by the STB. When this parameter is false Closed Captions will be output as VBI data in the video signal. This parameter only has an effect when Closed Captions are enabled by closedCaptionMode. NOTE! Only available for VIP1200. |
true, false |
false |
Streamer config, URI |
- |
CloseBlack |
Controls if video should be blacked out or freezed when closed. |
true, false |
true |
Application |
- |
ComponentOutput |
Indicates if component output should be enabled or disabled. |
true, false |
- |
MediaPlayer |
- |
_ConnectionType |
The connection type to the stream. |
RTSP, HTTP, Multicast, ... |
- |
Source element. |
- |
CurrentCciMarkerToken |
Indicates the most recently found CCI marker token in dvr playback. Cci marker tokens indicate when to set output control. |
String |
- |
Source Element |
- |
_CurrentContentId |
Indicates the contentId of the currently played dvr asset. This is used to verify IPRM licenses |
String |
- |
Source Element |
- |
_DataRelayMethod |
This parameter data is created by the TStreamer. |
Xmlbased relay method |
- |
TTsDataRelayElement |
- |
HalBufferSaturationTime |
The video decoder saturation time. |
0 - XXX. |
- |
Source element. |
- |
_DecoderVideoStreamInfo. |
Additional information about a video stream. The pid of the stream should be added at the end of the parameter name. |
XML data (see TMetaDecoderVideoStreamInfo) |
- |
Video sink element or Video Source element(Avi element). |
- |
_DemuxerInstance |
Used to inform the cable card service about the ParserBand number being used for the current session |
- |
- |
- |
- |
DescramblerKeysSet |
This parameter is set to true when the CA system has set the descrambler keys, used by ProgramExtractorElement to control data postponement |
The CRC32 of the ECM triggering the key change. |
- |
The CA system extension. |
- |
discardRtpHeaders |
If this parameter is set together with an igmp:// URI the incoming data is assumed to be RTP and the RTP header is discarded before the data is processed. This can be used to increase performance in the case where the RTP format is used on the network but the RTP functionality is not needed once the data reaches the STB. |
true, false |
false |
URI |
- |
_DiscontinuityCount |
This parameter shows how many times discontinuities has been detected when processing a stream. This can be used to indicate streamer disturbances visible to the user. |
0 - XXX |
- |
TTsContinuityElement |
- |
_DistributorDestinationUrl |
Contains destination URL for content distribution. |
protocol://ip-address |
- |
Streamer core |
- |
DivxDrmFile |
Indicates if DivX DRM file is played back or not. |
true, false |
- |
Avi File Source Element |
- |
DrmAuthorizedFlag |
Indicates if DivX DRM authorization is enabled or not. |
true, false |
- |
Avi File Source, PS-HW Elements |
- |
_DrmCopyingRestricted |
|
- |
- |
- |
- |
_DrmCopyrightAsserted |
The Copyright identifier got from PMT copyright descriptor. The Copyright additional info got from PMT copyright descriptor. |
A string
Boolean |
- |
The program selector element.
The program selector element. |
- |
_DrmDvrRestricted |
|
- |
- |
- |
- |
DrmRentalFlag |
Indicates if DivX DRM rental is enabled or not. |
true, false |
- |
Avi File Source Element |
- |
DrmUseCount |
The number of time the DivX file has been played back. |
Integer |
- |
Avi File Source Element |
- |
DrmUseLimit |
The number of playbacks allowed for the DivX file. |
Integer |
- |
Avi File Source Element |
- |
EncodingAps |
Indicates if APS copy protection for encoding is enabled or not. |
String |
- |
Analog Source Element |
- |
EncodingCgmsa |
Indicates if copy protection for encoding is enabled or not. |
Integer |
- |
Analog Source Element |
- |
EncodingMacrovision |
Indicates if Macrovision for encoding is enabled or not. |
Integer |
- |
Analog Source Element |
- |
_EndOfSequence |
This parameter is used to indicate end of stream/sequence thru the streamer chain to the halserver that it should decode available payload without waiting for any more. or interruptions in the stream. |
String ("end") |
- |
Source elements that have a finite end |
- |
_EndOfStream |
This parameter is used to indicate end of stream to the source element if it cannot realize it itself. |
end, beginning |
- |
TTsDsmCcElement, Streamer Core |
- |
errorrecovery |
The errorrecovery parameter determines how the STB will try to handle corrupt streams, e.g. in the case of packet loss. high means the STB will try to hide stream errors as much as possible. This may result in that instead of showing an area on screen with errors, an entire frame may be repeated (small picture freeze). NOTE! This is not available for VIP1200. |
high, medium, low |
high |
Streamer config, URI |
- |
_FlushDecoder |
Used by sourece elements to initiate the Decoders flush. mainly intended for use during state transsitions |
String. |
- |
Source elements. |
- |
_ForceEmptyNotification |
Force the streamer to send an OnEmpty message. Instead of waiting for hal to notice that the end is reached. |
true, false |
- |
PVR source element (playing MPEG4 content) |
- |
_GalaxieAudioTrackData |
Contains track info extracted from galaxie audio |
Track info |
- |
galaxie element |
- |
_IFrameOnly |
Enables playback of only IFrames in HAL. Used for trick play. |
true, false, first_i |
- |
PVR Source (and perhaps other source elements) |
- |
_IgmpSetupTime |
Contains the IGMP setup time in milliseconds. |
0 - XXX ms |
- |
Multicast Source element. |
- |
_IgnoreDiscontinuity |
Tells the element which checks for discontinuities to ignore errors. Used, for example, for "false" trick play. |
true, false |
- |
PVR Source (and perhaps other source elements) |
- |
_InjectDiscontinuity |
Tells the element that there is discontinuity in data |
true, false |
- |
DLNA Source element(and perhaps other source element) |
- |
_InjectEcm |
This parameter holds the ECM and pid. |
Binary encoded to base64 format by TMetaProgramSpecificInfo. |
- |
The program extractor element and the dvr source element. |
- |
_InjectPat |
This parameter holds the program map table and pid used for transport streams. |
Binary encoded to base64 format by TMetaProgramSpecificInfo. |
- |
The dvr source and program extractor elements. |
- |
_InjectPmt |
This parameter holds the program map table and pid used for transport streams. |
Binary encoded to base64 format by TMetaProgramSpecificInfo. |
- |
The dvr source and program extractor elements. |
- |
InputAudioFormat |
|
- |
- |
- |
- |
InputAudioPid |
|
- |
- |
- |
- |
InputPcrPid |
|
- |
- |
- |
- |
InputStreamType |
|
- |
- |
- |
- |
InputVideoFormat |
|
- |
- |
- |
- |
InputVideoPid |
|
- |
- |
- |
- |
Macrovision |
Indicates if Macrovision copy protection is enabled or not. |
true, false |
- |
MediaPlayer |
- |
_MonitorPmt |
This parameter is used to enable PMT monitoring in the program selector element to be able to suspend a program if the PMT disappears. Must be done according to ARIB specification TR-B15. |
true, false |
- |
The isdb source element |
- |
_NewPictureToBeDisplayed |
Tells the element that a new frame has been decoded and ready to display |
true, false |
- |
Media Decoder Controller element(and perhaps other element) |
- |
_OpenstreamEntitlement |
Contains an optional field used to convey session entitlement to the client of an RTSP OpenStream session that can be used by conditional access elements (EMM). Entitlements will not exceed 1024 characters and are encoded as hexadecimal strings. |
- |
- |
- |
- |
OutputAudioFormat |
|
- |
- |
- |
- |
OutputAudioPid |
|
- |
- |
- |
- |
OutputPcrPid |
|
- |
- |
- |
- |
OutputStreamType |
The Transcoder output parameters. PARAM_OUTPUT_STREAM_TYPE PARAM_OUTPUT_VIDEO_PID PARAM_OUTPUT_AUDIO_PID PARAM_OUTPUT_PCR_PID PARAM_OUTPUT_VIDEO_FORMAT PARAM_OUTPUT_AUDIO_FORMAT |
- |
- |
DLNA service. |
- |
OutputVideoFormat |
|
- |
- |
- |
- |
OutputVideoPid |
|
- |
- |
- |
- |
PauseBlack |
Controls if video should be blacked out or freezed when paused. |
true, false |
false |
Application |
- |
_PlaybackMode |
This is the playback mode of the stream. It can either be playing, rewinding or fastforwarding. This parameter should only be read by applications and it should be removed when a better interface is in place. |
0 - XXX |
- |
Streamer core. |
- |
_PlaySpeed |
Indicates decoding play speed. |
0 - XXX |
- |
Source elements. |
- |
PMT_BASE64 |
DEPRECATED This parameter holds the current program map table used for transport streams. |
Binary is encoded to Base64 format |
- |
TTsProgramSelectorElement |
- |
PMT |
This parameter holds the current program map table used for transport streams. |
Binary data |
- |
TTsProgramSelectorElement |
- |
_PmtFound |
Indicates whether the PMT has been found or not. |
true, false |
- |
The program selector element. |
- |
_PositionDiscontinuity |
Position discontinuity. Increments when the position in the stream is manually changed (e.g. by calls to PlayFromPosition). It can be monitored by other services (e.g. subtitles, ca-systems) that needs to know when a jump has been done. The absolute value is not of interest, only changes. |
0 - 255 |
- |
Source elements. |
- |
_PrebufferTime |
This parameter holds the prebuffer time. (The value can be adjusted from application by setting the "buftime" parameter) |
A positive integer in milliseconds. |
- |
Streamer Core |
- |
PreferredAudioEncoding |
Preferred audio encoding selection which overrides PARAM_AUDIO_ENCODING_PRIO_LIST |
encoding |
- |
Audio controller element |
- |
PreferredAudioLanguage |
Preferred audio language selection which overrides PARAM_AUDIO_ENCODING_PRIO_LIST |
language code |
- |
Audio controller element |
- |
PreferredAudioLangDescriptor |
Preferred audio language descriptor which overrides default behavior of using MPEG-2 ISO-639 Language Descriptor. |
AC3/MPEG |
- |
Streamer Core |
- |
ProxyList |
Contains the currently used proxy address by the system. |
IP address |
- |
- |
- |
PipMode |
Used for inform streamer element current player is in PiP mode or not. |
Boolean ("true"/"false") |
- |
TVideoControllerElement |
- |
_FdReceiveSocket |
This parameter contains the file descriptor of the receive socket. |
0 - XXX. |
- |
Source Element |
- |
RecordingType |
This parameter contains Recording type. Recording type may be AUDIO_ONLY or VIDEO_ONLY or AUDIO_VIDEO |
A string. |
- |
Application |
- |
_RequestAudioChannelMode |
This parameter is used to request an active audio stream mode from audio sink element. |
0 - XXX (see IStreamerType::TAudioChannelMode) |
- |
TStreamer |
- |
_RequestAudioStream |
This parameter is used by the Session to request an active audio stream from the audio sink element. |
0 - XXX |
- |
TStreamer |
- |
_RequestProgram |
This parameter is used by the Session to request an active program from the program selector element. |
0 - XXX |
- |
TStreamer |
- |
_RequestSubtitleStream |
This parameter is used by the Session to request an active subtitle stream from the subtitle sink element. |
0 - XXX |
- |
TStreamer |
- |
_RequestTeletextStream |
This parameter is used by the Session to request an active teletext stream from the teletext sink element. |
0 - XXX |
- |
TStreamer |
- |
_RequestVideoStream |
This parameter is used by the Session to request an active video stream the from video sink element. |
0 - XXX |
- |
TStreamer |
- |
RtspNow |
When this parameter is set to true, the RTSP play message will be issued with the range "npt=now-". This is only valid when playing a stream from a RTSP server that supports this feature. |
true, false |
false |
URI |
- |
SoundMode |
Sound mode |
currently "SPDIF" or != "SPDIF" |
- |
MediaPlayer |
- |
_SourceClocked |
Indicates that the source is clocked. |
true, false |
- |
Streamer Core |
- |
_SourceServer |
The name of the server when known (e.g. "Kasenna XMP" or "nCube") |
Server name |
- |
Source element. |
- |
startmode |
The parameter will configures how the streamer starts a stream. When the parameter is set to adaptive, the STB will show video in "slow motion" until A/V sync is correct. This can be useful when playing h264 streams with large A/V diff. When the parameter is set to normal, the STB will display a black image until audio and video are in sync. NOTE! VIP1500/1700 only support fast or normal mode. VIP1200 always use normal mode. |
fast - Show a picture as fast as posible.
normal - Don't show anything until A/V sync.
adaptive - Show video in slow motion until A/V sync is correct. |
normal |
Streamer config, URI |
- |
StatisticsBeforeCa |
In some cases it is desirable to restrict the range of playback for an asset. This parameter determines the start time in seconds into the asset. While this parameter is in effect, it is not possible to go to a position before the defined time. The parameter is primarily intended for use together with the duration parameter. NOTE! Only implemented for RTSP type servers This parameter determines if the server should avoid playing the entire asset, and selects how much of the asset should be played before reporting end of stream. NOTE! Only implemented for RTSP type servers When this parameter is true, data received before the new PAT/PMT when changing to a new channel is considered valid. On average this gives slightly faster zap times, but can also result in image/video disturbances. This is used to control if the statistics element will precede the CA element. |
0 - XXX s
0 - XXX s
true, false
true, false |
true
false |
Streamer config, URI
Streamer config, URI
Streamer config, URI
Streamer config, URI |
- |
StreamerMode |
Used to inform streamer element(s) if the streamer is in atsc mode and hence to conditionally recognize DC-II as a valid video type. |
atsc (or null) |
- |
Streamer Config |
- |
_StreamFormat |
The stream format. |
MPEG1/System, MPEG2/Program, MPEG2/Transport, ... |
- |
Framing element. |
- |
_StreamPaces |
The valid paces in which the position can be updated during this stream. |
pace list seperated by comma |
- |
RTSP source element |
- |
_StreamPlayTime |
The play time of the stream in milliseconds. |
0 - XXX ms |
- |
Source element. |
- |
_StreamStc |
The current value of the STC associated with the stream. |
A positive integer (33 bit 90kHz counter). |
- |
The program selector element. |
- |
_StreamTitle |
The title of the stream. |
Title |
- |
Asf, Shoutcast & Bitband elements. |
- |
_StreamUrl |
The URL to the stream. |
URL |
- |
Source element. |
- |
SubtitleAutomaticSelection |
Used for enable or disable automatic subtitle selection |
Boolean ("true"/"false") |
- |
MediaPlayer (reading from infobroker) |
- |
SubtitleLanguagePriorityList |
Priority list for automatic subtitle language selection |
comma separated list of language codes |
- |
MediaPlayer (reading from infobroker) |
- |
SubtitleModePriorityList |
Priority list for automatic subtitle mode selection |
comma separated list of subtitle modes (DVB, Teletext) |
- |
MediaPlayer (reading from infobroker) |
- |
SubtitleSocketName |
Information about a subtitle stream. The pid of the stream should be added at the end of the parameter name. Information about a teletext stream. The pid of the stream should be added at the end of the parameter name. Socket name used by subtitle render to receive subtitles data. |
sti
XML data (see TMetaTeletextStreamInfo)
string |
- |
Subtitle stream info decoder element.
Subtitle stream info decoder element.
Subtitle render |
Subtitle sink element |
_SubtitleStreamList |
List of pids of subtitle streams (in the current program). |
XML data (see TMetaStreamList) |
- |
Subtitle stream info decoder element. |
- |
SubtitleTypePriorityList |
Priority list for automatic subtitle type selection |
comma separated list of subtitle types (normal, hearing_impaired) |
- |
MediaPlayer (reading from infobroker) |
- |
_TeletextStreamList |
List of pids of teletext streams (in the current program). |
XML data (see TMetaStreamList) |
- |
Subtitle stream info decoder element. |
- |
TranscoderConfig |
The Transcoder input parameters. PARAM_INPUT_STREAM_TYPE PARAM_INPUT_VIDEO_PID PARAM_INPUT_AUDIO_PID PARAM_INPUT_PCR_PID PARAM_INPUT_VIDEO_FORMAT PARAM_INPUT_AUDIO_FORMAT |
- |
- |
DLNA service. |
- |
UseProgramCache |
Controls if the Program Cache should be used. |
true, false |
false |
Typically a source element that want cached PMT:s (like dvb) |
- |
VideoBitRate |
This parameter contains the video bitrate. |
A string. |
- |
Application |
- |
_VideoControllerReady |
This parameter is used to inform streamer elements if video controller ready or not. |
true, false |
false |
Video controller element |
- |
VideoDecoderState |
The videodecoder can either be in a ready state or awaiting configuration. |
ready, stopped |
- |
TVideoDecoderControllerElement |
- |
_VideoDecoderType |
This parameter contains the decoder type for the sink element. |
A string. |
- |
Source Element |
- |
VideoFrameRate |
This parameter contains the video frame rate. |
A string. |
- |
Application |
- |
VideoResolutionX |
This parameter contains the video width. |
A string. |
- |
Application |
- |
VideoResolutionY |
This parameter contains the video height. |
A string. |
- |
Application |
- |
_VideoStreamInfo. |
Information about a video stream. The pid of the stream should be added at the end of the parameter name. |
XML data (see TMetaVideoStreamInfo) |
- |
Video stream info decoder element. |
- |
_VideoStreamList |
List of pids of video streams (in the current program). |
XML data (see TMetaStreamList) |
- |
Video stream info decoder element. |
- |