Monitoring Data Points

Key Stats

duration currentTime downloadRatio downloadKbps playbackKbps lsoDownloadKbps memory droppedFrames avgDroppedFPS streamType

Buffer

percentage time length eventCount avgWaitDuration totalWaitDuration previousWaitDuration maxWaitDuration

Key Stats

duration: Length of stream in seconds
currentTime: Time index of video in seconds
downloadRatio: Used for computing max bandwidth in HTTP Dynamic Streaming connections
downloadKbps: HTTP Dynamic Streaming download kilobits per second
playbackKbps: HTTP Dynamic Streaming playback kilobits per second
lsoDownloadKbps: Local Shared Object download kilobits per second
memory: Memory usage in mb
droppedFrames: Number of frames dropped total
avgDroppedFPS: Average frames dropped per second
streamType: [ recorded | live | dvr ], always set live or dvr for hls stream

Buffer

percentage: Percent of the default (10 sec) buffer that's filled
time: The amount of the buffer (in seconds) that must be filled before playback begins
length: The amount of playback time in seconds that's currently in the buffer
eventCount: The total number of buffering events
avgWaitDuration: Avg in seconds waited to fill buffer
totalWaitDuration: Total wait in seconds buffering
previousWaitDuration: Wait duration of the last buffering event
maxWaitDuration: Maximum wait duration of the longest buffering event

Dynamic streaming

index: Dynamic streaming numbers only active during dynamic stream
numDynamicStreams: Number of HTTP Dynamic streams
currentBitrate: Current bitrate of HTTP Dynamic streams in kilobits per second
previousSwitchDuration: Duration of previous HTTP dynamic stream switch in seconds
totalSwitchDuration: Total duration in seconds of HTTP dynamic stream switching in seconds
dsSwitchEventCount: Total number of HTTP dynamic stream switches
avgSwitchDuration: Average duration in seconds of HTTP dynamic stream switching in seconds
currentVerticalResolution: Current Vertical Resolution
bestVerticalResolution: Best vertical resolution of HTTP dynamic stream
bestHorizontatalResolution: Best horizontal resolution of HTTP dynamic stream
targetBitrate: Target bitrate of HTTP dynamic stream
targetIndex: Current HTTP Dynamic stream target index

Rendering

width: Video width in pixels
height: Video height in pixels
aspectRatio: Video aspect ratio
displayObjectWidth: Video display object width in pixels
displayObjectHeight: Video display object height in pixels
displayObjectRatio: Video display object aspect ratio
HD: High definition rendering used (true/false)
smoothing: Player render smoothing used (true/false)
deblocking: Lets the video compressor apply the deblocking filter as needed.
fullScreenSourceRect: Full screen source rectangle coordinates
fullScreenSourceRectAspectRatio: Aspect ratio of full screen rectangle.
screenWidth: Client screen width in pixels
screenHeight: Client screen height in pixels
screenAspectRatio: Aspect ratio of client screen

Asset

clipEndTime: Specifies an offset in seconds from the beginning of the content stream. When specified, the stream is presented as a subclip, with playback stopping at the given end time. The default value is NaN, which plays the content to the actual end of the stream. Progressive content is unaffected by this setting.
clipStartTime: Specifies an offset in seconds from the beginning of the content stream. When specified, the stream is presented as a subclip, with playback beginning at the given start time. The default value is NaN, which starts playback at the actual beginning of the stream. Progressive content is unaffected by this setting.
streamType: [ recorded | live | dvr ], always set live or dvr for hls stream
url: Complete url of source media
urlIncludesFMSApplicationInstance: Whether the url includes the FMSA Application instance

Player Configuration

backgroundColor: Background color of the player
bufferingOverlay: Enables whether the buffering overlay appears on top of the video object
controlBarAutoHide: Whether the player’s controls are visible at all times. With the default value (true), the controls are not displayed unless the user is hovering the mouse over the player. When this occurs, the controls remain visible while the user interacts with the player and for an additional period of time equal to the controlBarAutoHideTimeout setting. With a value of false, the controls are continuously visible and may reduce the amount of the player window available to display content.
controlBarAutoHideTimeout: A duration, in seconds, for the control bar to remain visible, after the user has stopped interacting with the player. Default is 3. This value is used when controlBarAutoHide is set to true
controlBarMode: The location where the player’s controls are displayed. The default value sets the controls along the bottom of the player window. A value of floating displays the control bar hovering over the content, near the bottom of the window If a value of none is set, no control bar is displayed.
controlBarType: Whether the controlbar is in tablet, mobile or desktop mode
enableStageVideo: Whether the video stage is enabled or disabled
endOfVideoOverlay: A URL specifying an image to display in the player window after playback completes. This value is set to the value of the poster setting by default, so that the same poster image appears at the end as at the beginning of playback. The same file type restrictions as for poster apply.
expandedBufferTime: The maximum size of the buffer (in seconds) that the player attempts to fill, once playback has begun. The default value is 10 seconds. If optimizeBuffering is set to true, the player uses this value along with fast-start buffering to optimize buffering for high-speed networks.
haltOnError: If set to true, the player stops loading and displays an error if there is a problem loading a plug-in.
initialBufferTime: The amount of the buffer (in seconds) that must be filled before playback begins. The default value is 0.1 second. If optimizeBuffering is set to true, the player uses this value when enabling fast-start buffering for high-speed networks.
javascriptCallbackFunction: name of callback function?
minContinuousPlaybackTime: The minimum amount of playback time without pausing to refill the buffer. The default value is 30 seconds. The player’s optimized buffering algorithm uses this value to compute a target buffer size for low-speed networks. This setting only applies to streaming content, not progressive downloads
multicastNetConnectionFactoryTimeout: Default timeout in seconds for multicast connections
optimizeBuffering: The default value allows fast-start buffering for high-speed networks and dynamic calculation of buffer size for low-speed networks. This setting has no effect on dynamic (MBR) streams or live/DVR content.
optimizeInitialIndex: The default value allows the player to use dynamic streaming for multi-bitrate (MBR) content. When the user starts playback, the player uses the download speed of the network connection to select the optimal starting bitrate stream.
playButtonOverlay: The default value displays a large Play button over the center of the player window before playback begins.
poster: A URL specifying an image to display in the player window before playback begins. If no default poster image is provided, the player displays the current background color. The image must be in a bitmap image format, such PNG, BMP, or JPG. Vector images, movies, or animations are not supported.
removeContentFromStageOnFullScreenWithStageVideo: Remove content from main stage when full screen is initiated
rtmpNetConnectionFactoryTimeout: Default timeout in seconds for rtmp connections
scaleMode: Determines how the source content is sized within the player window. The default letterbox value allows the content to be resized to fit the player window, but constrains the dimensions of the content to maintain its original aspect ratio. A value of none does not allow the content to be resized. A value of stretch sets the dimensions of the content to that of the player window, possibly changing the aspect ratio of the content in the process. A value of zoom displays the content filling the player window, while maintaining its original aspect ratio; this may cause cropping of the content’s horizontal or vertical edges.
showVideoInfoOverlayOnStartUp: Determines whether or not to show video info overlay on startup
skin: A URL specifying the location of a file containing alternate images for the player’s user interface elements. For more details, see Changing the Appearance of the Player
src: Player source URL
tintColor: Default tint color (black)
useFullScreenSourceRectOnFullScreenWithStageVideo: Whether or not to use the full screen source rectangle coordinates on full screen
verbose: Whether to display detailed error messages for debugging. The default value (false) causes the display of simplified, user-friendly error messages.
metadata[retryInterval]: Interval in seconds to poll metadata
metadata[retryLive]: Enable whether metadata is retried on live streams
url: Plugin base url

Player

alternativeAudioStreamSwitching: Enables or disables the switching of alternate audio streams
audioPan: Pan property of the media * Ranges from -1 (full pan left) to 1 (full pan right).
autoDynamicStreamSwitch: Auto stream switch enabled or disabled
autoPlay: Auto play enabled or disabled
autoRewind: Auto rewind enabled or disabled
bufferLength: Current buffer length in seconds
bufferTime: Time spent buffering in seconds
buffering: Whether or not the player is currently buffering
bytesLoaded: The number of bytes of data that have been loaded into the player. You can use this method in conjunction with NetStream.bytesTotal to estimate how close the buffer is to being full--for example, to display feedback to a user who is waiting for data to be loaded into the buffer.
bytesLoadedUpdateInterval: Interval in milliseconds the bytes loaded is checked
bytesTotal: The total size in bytes of the file being loaded into the player.
canBuffer: Indicates whether the media can buffer.
canLoad: Indicates whether the media can load
canPause: Indicates whether the media can pause
canPlay: Indicates whether the media can play
canSeek: Indicates whether the media can seek
currentAlternativeAudioStreamIndex: Time index in seconds of alternative audio stream
currentDynamicStreamIndex: Current index number of dynamic stream
currentSrc: Current loaded source that's playing
currentTime: Current time in seconds of playback
currentTimeUpdateInterval: Interval in milliseconds thecurrent time is checked
drmPeriod: Returns the length of the playback window, in seconds. Returns NaN if * authentication hasn't taken place or if hasDRM is false.
drmState: The current state of the DRM for this media. The states are explained * in the DRMState enumeration in the org.osmf.drm package
duration: duration of current media
dvrBufferTime: Default DVR buffer time in seconds
dvrDynamicStreamingBufferTime: Default Dynamic Stream DVR buffer time in seconds
dvrSnapToLiveClockOffset: How many seconds before live should the player should start playing at
dynamicStreamBufferTime: Default Dynamic Stream buffer time in seconds
dynamicStreamSwitching: Whether dynamic stream switching is enabled
hasAlternativeAudio: Whether the current stream has alternative audio associated with it
hasAudio: Whether the current stream has audio
hasDRM: Whether the current stream has DRM
highQualityThreshold: Defines the high quality threshold
isDVRLive: Defines whether or not the stream is in live dvr mode
isDVRRecording: Defines whether or not the stream is a dvr recording
isDynamicStream: Defines whether or not the stream is a dynamic stream
isLive: Defines whether or not the stream is live
liveBufferTime: Default time in seconds spent buffering a live stream
liveDynamicStreamingBufferTime: Default time in seconds spent buffering a live dynamic stream
loop: Whether or not to loop the playback
maxAllowedDynamicStreamIndex: Highest index for dynamic streaming
mediaHeight: Current media height in pixels
mediaWidth: Current media width in pixels
muted: Whether or not the player is muted
numAlternativeAudioStreams: Total number of alternative audio streams
numDynamicStreams: Total number of dynamic streams
paused: Whether or not the player is paused
playing: Whether or not the player is playing
seeking: Whether or not the player is seeking
state: Current state of the Media Player
temporal: Whether or not temporal metadata is to be loaded
videoHeight: Current video height of the media player
videoRenderingMode: Current video rendering mode of the media player
videoWidth: Current video width of the media player
volume: Current volume of the media player
streamType: Current stream type loaded in current media player instance

MediaPlayer

alternativeAudioStreamSwitching: Whether or not alternative audio stream switching is enabled
audioPan: Pan property of the media * Ranges from -1 (full pan left) to 1 (full pan right).
autoDynamicStreamSwitch: Auto stream switch enabled or disabled for dynamic streams
autoPlay: Auto play enabled or disabled
autoRewind: Auto rewind enabled or disabled
bufferLength: Buffer length in seconds
bufferTime: Time spent buffering in seconds
buffering: Whether or not the player is currently buffering
bytesLoaded: The number of bytes of data that have been loaded into the player
bytesLoadedUpdateInterval: Interval in milliseconds the bytes loaded is checked
bytesTotal: The total size in bytes of the file being loaded into the player
canBuffer: Indicates whether the media can buffer
canLoad: Indicates whether the media can load
canPause: Indicates whether the media can pause
canPlay: Indicates whether the media can play
canSeek: Indicates whether the media can seek
currentAlternativeAudioStreamIndex: Time index in seconds of alternative audio stream
currentDynamicStreamIndex: Current index number of dynamic stream
currentSrc: Current loaded source that's playing
currentTimeUpdateInterval: Interval in milliseconds the current time is checked
drmPeriod: Returns the length of the playback window, in seconds. Returns NaN if * authentication hasn't taken place or if hasDRM is false
drmState: The current state of the DRM for this media. The states are explained * in the DRMState enumeration in the org.osmf.drm package
duration: Duration of current media
dvrBufferTime: Default DVR buffer time in seconds
dvrDynamicStreamingBufferTime: default time in seconds spent buffering a live dynamic stream
dvrSnapToLiveClockOffset: How many seconds before live should the player should start playing at
dynamicStreamBufferTime: Default Dynamic Stream buffer time in seconds
dynamicStreamSwitching: Whether dynamic stream switching is enabled
hasAlternativeAudio: Whether the current stream has alternative audio associated with it
hasAudio: Whether the current stream has audio
hasDRM: Whether the current stream has DRM
highQualityThreshold: Defines the high quality threshold
isDVRLive: Defines whether or not the stream is in live dvr mode
isDVRRecording: Defines whether or not the stream is a dvr recording
isDynamicStream: Defines whether or not the stream is a dynamic stream
isLive: Defines whether or not the stream is live
liveBufferTime: Default time in seconds spent buffering a live stream
liveDynamicStreamingBufferTime: Default time in seconds spent buffering a live dynamic stream
loop: Whether or not to loop the playback
maxAllowedDynamicStreamIndex: Highest index for dynamic streaming
mediaHeight: Current media height in pixels
mediaWidth: Current media width in pixels
muted: Whether or not the player is muted
numAlternativeAudioStreams: Total number of alternative audio streams
numDynamicStreams: Total number of dynamic streams
paused: Whether or not the player is paused
playing: Whether or not the player is playing
seeking: Whether or not the player is seeking
state: Current state of the Media Player
streamType: The type of media stream to support. The default setting plays both live and recorded media, with no digital video recording (DVR) features
temporal: Whether or not temporal metadata is to be loaded
videoHeight: Current video height of the media player
videoRenderingMode: Current video rendering mode of the media player
videoWidth: Current video width of the media player
volume: current volume of the media player

NetStreamInfo

SRTT: Smoothed Round Trip Time for the NetStream session, in milliseconds. This property is valid only for the RTMFP streams. For RTMP streams, it returns 0.
audioBufferByteLength: Current length in bytes of the audio buffer
audioBufferLength: Current length in seconds of the audio buffer
audioByteCount: Total audio bytes received
audioBytesPerSecond: Current audio bytes received per second
audioLossRate: Current audio loss rate
byteCount: Total Bytes received
currentBytesPerSecond: Current bytes received per second
dataBufferByteLength: Current length in bytes of the data buffer
dataBufferLength: Current length in seconds of the data buffer
dataByteCount: Total data bytes received
dataBytesPerSecond: Current data bytes received per second
droppedFrames: Total number of dropped frames
isLive: Whether or not the stream is live
maxBytesPerSecond: Highest sampled bytes received per second
playbackBytesPerSecond: Bitrate of the content that's currently being played back in bytes
resourceName: Location of resource on media server
uri: Media server url
videoBufferByteLength: Current length in bytes of the video buffer
videoBufferLength: Current length in seconds of the video buffer
videoByteCount: Total video bytes received
videoBytesPerSecond: Current video bytes received per second
videoLossRate: Current video loss rate

NetStream

audioCodec: Index of audio codec in use
audioReliable: For RTMFP connections, specifies whether audio is sent with full reliability
backBufferLength: The number of seconds of previously displayed data that currently cached for rewinding and playback
backBufferTime: Specifies how much previously displayed data Flash Player tries to cache for rewinding and playback, in seconds
bufferLength: The number of seconds of data currently in the buffer
bufferTime: Specifies how long to buffer messages before starting to display the stream
bufferTimeMax: Specifies a maximum buffer length for live streaming content, in seconds
bytesLoaded: The number of bytes of data that have been loaded into the application
bytesTotal: The total size in bytes of the file being loaded into the application
checkPolicyFile: Specifies whether the application tries to download a cross-domain policy file from the loaded video file's server before beginning to load the video file
currentFPS: The number of frames per second being displayed
dataReliable: For RTMFP connections, specifies whether NetStream.send() calls are sent with full reliability
decodedFrames: Number of frames that have been decoded during playback
farID: For RTMFP connections, the identifier of the far end that is connected to this NetStream instance
farNonce: For RTMFP and RTMPE connections, a value chosen substantially by the other end of this stream, unique to this connection
inBufferSeek: Specifies whether displayed data is cached for smart seeking (TRUE), or not (FALSE)
liveDelay: The number of seconds of data in the subscribing stream's buffer in live (unbuffered) mode
maxPauseBufferTime: Specifies how long to buffer messages during pause mode, in seconds
multicastAvailabilitySendToAll: For RTMFP connections, specifies whether peer-to-peer multicast fragment availability messages are sent to all peers or to just one peer
multicastAvailabilityUpdatePeriod: For RTMFP connections, specifies the interval in seconds between messages sent to peers informing them that the local node has new peer-to-peer multicast media fragments available
multicastFetchPeriod: For RTMFP connections, specifies the time in seconds between when the local node learns that a peer-to-peer multicast media fragment is available and when it tries to fetch it from a peer
multicastPushNeighborLimit: For RTMFP connections, specifies the maximum number of peers to which to proactively push multicast media
multicastRelayMarginDuration: For RTMFP connections, specifies the duration in seconds that peer-to-peer multicast data remains available to send to peers that request it beyond a specified duration
multicastWindowDuration: For RTMFP connections, specifies the duration in seconds of the peer-to-peer multicast reassembly window
nearNonce: For RTMFP and RTMPE connections, a value chosen substantially by this end of the stream, unique to this connection.
objectEncoding: The object encoding (AMF version) for this NetStream object
useHardwareDecoder: Specifies whether to use hardware accelerated decoding on the stream
useJitterBuffer: Minimize latency for live un-buffered streaming (bufferTime = 0)
videoCodec: Index of video codec in use
videoReliable: For RTMFP connections, specifies whether video is sent with full reliability