ARRIS Enterprises, Inc. Confidential Information

Media Player Parameters

The Media Player publishes information about its operation in the form of parameters. These provide detailed insight into the status of the Media Player and other elements that participate in the media playback. Use getParameters() to read parameters, or subscribeParameters() to subscribe to updates in parameters.

Some parameters can also be set, allowing the application to fine-tune the operation of the media player. It can be done by using setParameters() or with an extended URL.

Applications can also set or read parameters by using the corresponding methods in the ToiMediaSession interface.

Configuration Parameters

Parameter	Description	Values	Default
CloseBlack	Controls if video should be blacked out or frozen when closed.	true, false	true
DisableAudioSyncLogic	To override the synchronization logic for audio only streams set this parameter to true. If set, the audio synchronization will be disabled. This can sometimes be necessary when playing audio-only streams that do not contain any PCRs.	true, false	false
ExtractorDisable	When this parameter is true the program extractor will be disabled. Note that this could slow down multicast channel changes.	true, false	false
ExtractorPmtFeedback	When this parameter is true, the Program Extractor element will release stream segments as soon as the PMT is available instead of waiting for timeout or ECM data.	true, false	false
LiveSource	When adding the parameter LiveSource=true to an http uri, the source is treated as a live source with the exception that the transport stream arrival is not expected to be as punctual as for normal live sources.	true, false	false
PauseBlack	Controls if video should be blacked out or frozen when paused.	true, false	false
RtspDescribePollInterval	Interval (in seconds) used for periodically sending RTSP DESCRIBE messages when receiving a "real-time feed" (an RTSP resource whose duration changes).	1 - 600	30
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
RtspTrickplayIframeOnly	Determines the way RTSP winding is done. Either all frames of the winding stream are shown, or just the I-frames. Default is to only show the I-frames.	true, false	true
SsInitialBandwidthLimit	Used by Smooth Streaming format handler to know the maximum allowed bandwidth when selecting the initial variant. If the value is set lower than the lowest available variant, the lowest available variant will be used anyway. The unit is bytes per second.	bytes / second	-
StatisticsReset	Used for resetting all statistics. A value of 1 indicate that the statisics should be reset.	0, 1	-
buftime	Controls how much data, in milliseconds, is buffered before starting to play a stream. The higher the value the longer it takes to start playback, e.g. when switching TV channels. If the value is set too low however, there is a risk that the buffers might be emptied during playback due to network jitter, which will cause the service to stall for a moment while the buffers are being replenished.	0 - 3000 ms	500 ms
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
duration	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	seconds	-
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).	high, medium, low	high
prebuftime_for_audio_only	Value of prebuffer time for streams without video, but with audio only - radio streams.	milliseconds	buftime
startmode	Controls how the streamer behaves during playback start. When the parameter is set to normal, the STB will display a black image until audio and video are in sync. When the parameter is set to fast, the STB will show a picture as soon as possible.	fast, normal	normal
starttime	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	seconds	-

Informative Parameters

Parameter	Description	Values	Default
HlsActiveVariantBandwidth	Used to publish the currently selected variant stream bandwidth. The unit is bits per second.	bits / second	-
HlsAvailableVariantStreams	Used to publish information about the available variant streams as a XML structure. Example: <?xml version="1.0"?> <HlsInfoList> <HlsInfo> <Bandwidth>XXX</Bandwidth> <!-- Unit is bits per second --> </HlsInfo> <HlsInfo> <Bandwidth>YYY</Bandwidth> </HlsInfo> </HlsInfoList>	XML	-
StatisticsBufferOverrun	The number of buffer overruns.	-	-
StatisticsBufferUnderrun	The number of buffer underruns.	-	-
StatisticsEmptyBufferTime	The time period the playout buffer was empty.	milliseconds	-
StatisticsLossEvents	Total number of Loss Events for this stream before EC.	-	-
StatisticsLossEventsBeforeEC	Total number of Loss Events for this stream after EC.	-	-
StatisticsMaximumLossPeriod	The length in RTP packets of the longest Loss Event for this AV stream during the sample interval.	-	-
StatisticsMaximumLossPeriodBeforeEC	The length in RTP packets of the longest Loss Event for this AV stream during the sample interval. There statistics are collected before any EC, if available, is applied.	-	-
StatisticsMinimumLossDistance	The length in RTP packets of the shortest distance between consecutive Loss Events for this AV stream during the sample interval.	-	-
StatisticsMinimumLossDistanceBeforeEC	The length in RTP packets of the shortest distance between consecutive Loss Events for this AV stream during the sample interval. There statistics are collected before any EC, if available, is applied.	-	-
StatisticsPacketsOutOfSequence	Total number of packets out of sequence at the RTP level for this AV stream, regardless of their being too late for playout or not.	-	-
StatisticsRtpDiscardedPackets	Total number of packets discarded at the RTP layer for this AV stream because they were too late for playout, regardless of their being out of sequence or not.	-	-
StatisticsRtpExpectedPackets	The total number of RTP packets expected for this AV stream during the sample interval.	-	-
StatisticsRtpLostPackets	Total number of RTP packets lost for this stream after EC.	-	-
StatisticsRtpLostPacketsBeforeEC	Total number of RTP packets lost for this stream before EC.	-	-
StatisticsRtpTotalPackets	The number of RTP packets received for this AV stream after EC.	-	-
StatisticsRtpTotalPacketsBeforeEC	The number of RTP packets received for this AV stream before EC.	-	-
StatisticsSevereLostLengthCountBeforeEC	The total number of Loss Events longer than SevereLossMinLength. There statistics are collected before any EC, if available, is applied.	-	-
StatisticsTimePlaying	The total playing time in state playing.	milliseconds	-
StatisticsTimeTotal	The total playing time from open to now.	milliseconds	-
StatisticsTsAVOutOfSyncs	The number of a/v unsync seen by the streamer when playing.	-	-
StatisticsTsAudioDecodedFrames	The number of audio frames that were decoded completely (errorless frames) or partially (corrupted frames).	-	-
StatisticsTsAudioDecodingErrors	The number of times the audio decoder has decoding errors	-	-
StatisticsTsConcealedFrames	The number of video frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream.	-	-
StatisticsTsDecodingErrors	The number of times the video decoder has decoding errors.	-	-
StatisticsTsDuplicatePackets	The number of duplicate TS packets seen by the streamer.	-	-
StatisticsTsErrorPackets	The number of corrupted TS packets seen by the streamer. Should probably always be 0.	-	-
StatisticsTsIConcealedFrames	The number of I frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream.	-	-
StatisticsTsIFrameCount	The total number of decoded IFrames	-	-
StatisticsTsIFrameLost	The number of I Frame lost while the streamer playing.	-	-
StatisticsTsLostPackets	The number of lost TS packets seen by the streamer.	-	-
StatisticsTsPacketsDrained	The number of TS Packets drained while the streamer playing.	-	-
StatisticsTsTotalBytes	The number of bytes seen by the streamer including TS headers.	Bytes	-
StatisticsTsTotalBytesPlayed	The number of bytes seen by the streamer when playing. This value will have the same value as STATISTICS_TS_TOTAL_BYTES.	Bytes	-
StatisticsTsTotalPackets	The number of TS packets seen by the streamer.	-	-
StatisticsTsVideoDecodedPictures	Number of decoded pictures.	-	-
StatisticsTsVideoDecodingErrors	The number of times the video decoder has decoding errors.	-	-
StatisticsTsVideoFrameRate	Source Video frame rate in 1/1000 units.	-	-
StatisticsUrl	The URL to the stream.	URL	-