====== Media Player Layer (player) ====== This layer is used to play a media file. It can be placed on top of an RTP, SRTP, TTS, ASR, audio, generator or detector layer. ===== Media Player Layer Configuration Parameters ===== ^ Parameter^ Type^ Description^ | Alias| String| | | Debug Log Level| Number| Debug Level| | Dependencies| String| Other dependencies to this element| | Destination Peer| Number| | | Event Filter| String| Filter of Event| | Exact Match| Boolean| | | Filename| Number| Filename| | Max Event Queue Size| Number| Maximum Queue Size| | Max Instances| Number| Maximum Number of Instances of a Component| | Name| String| Component Name| | No Events| Boolean| | | Passthrough| Boolean| High-to-Low Layer Passthrough| | Raw Data To Inject| String| Data Packet to Inject| | Raw Dst L2 To Inject| String| Destination L2 Address| | Raw Dst L3 To Inject| String| Destination L3 Address| | Raw Dst L4 To Inject| String| Destination L4 Address| | Request Timeout| Number| | | Save Dynamic Config| Boolean| | | Show Commands| Boolean| Show Commands| | Show Events| Boolean| Show Events| | Watch| Boolean| Watch Layer| ===== Media Player Layer Real-Time Parameters ===== ^ Parameter^ Type^ Description^ | Allow Blocking Event| Boolean| Blocking Events| | Blocked| Boolean| Disable Component| | Counter| Number| Times to Play a Prompt| | Debug Log Level| Number| Debug Level| | Filename| String| Filename| | Max Instances| Number| Maximum Number of Instances of a Component| | Passthrough| Boolean| High-to-Low Layer Passthrough| | Watch| Boolean| Watch Layer| ===== Media Player Layer Functions ===== ^ Function^ Type^ Description^ | getPlayerAllowBlockingEvent(layer)| getter| Get "Allow Blocking Event" Parameter| | getPlayerBlocked(layer)| getter| Get "Blocked" Parameter| | getPlayerCounter(layer)| getter| Get "Counter" Parameter| | getPlayerDebugLogLevel(layer)| getter| Get "Debug Log Level" Parameter| | getPlayerDestinationPeer(layer)| getter| Get "Destination Peer" Parameter| | getPlayerFilename(layer)| getter| Get "Filename" Parameter| | getPlayerMaxInstances(layer)| getter| Get "Max Instances" Parameter| | getPlayerNoEvents(layer)| getter| Get "No Events" Parameter| | getPlayerPassthrough(layer)| getter| Get "Passthrough" Parameter| | getPlayerWatch(layer)| getter| Get "Watch" Parameter| | getStatsPlayerAvailableInstances(layer)| getter| Get "Available Instances" Parameter| | getStatsPlayerDownstreamLastPacket(layer)| getter| Get "Downstream Last Packet" Parameter| | getStatsPlayerDownstreamPacketCount(layer)| getter| Get "Downstream Packet Count" Parameter| | getStatsPlayerMaxDownstreamDelay(layer)| getter| Get "Max Downstream Delay" Parameter| | getStatsPlayerMaxUpstreamDelay(layer)| getter| Get "Max Upstream Delay" Parameter| | getStatsPlayerMeanDownstreamDelay(layer)| getter| Get "Mean Downstream Delay" Parameter| | getStatsPlayerMeanUpstreamDelay(layer)| getter| Get "Mean Upstream Delay" Parameter| | getStatsPlayerMinDownstreamDelay(layer)| getter| Get "Min Downstream Delay" Parameter| | getStatsPlayerMinUpstreamDelay(layer)| getter| Get "Min Upstream Delay" Parameter| | getStatsPlayerName(layer)| getter| Get "Name" Parameter| | getStatsPlayerRateBpsDownstream(layer)| getter| Get "Rate Bps Downstream" Parameter| | getStatsPlayerRateBpsUpstream(layer)| getter| Get "Rate Bps Upstream" Parameter| | getStatsPlayerTimestampIn(layer)| getter| Get "Timestamp In" Parameter| | getStatsPlayerTimestampOut(layer)| getter| Get "Timestamp Out" Parameter| | getStatsPlayerType(layer)| getter| Get "Type" Parameter| | getStatsPlayerUpstreamLastPacket(layer)| getter| Get "Upstream Last Packet" Parameter| | getStatsPlayerUpstreamPacketCount(layer)| getter| Get "Upstream Packet Count" Parameter| | getStatsPlayerVarianceDownstreamDelay(layer)| getter| Get "Variance Downstream Delay" Parameter| | getStatsPlayerVarianceUpstreamDelay(layer)| getter| Get "Variance Upstream Delay" Parameter| | isEventPlayerStart(event)| event| Start Event| | isEventPlayerStop(event)| event| Stop Event| | playerBlockOnStop(event)| function| Player Blocks on Stop| | playerMute(layer)| function| Mute| | playerPause(layer)| function| Pause Playing| | playerPlay(layer)| function| Play| | playerPlayBlk(layer)| function| Blocking Play| | playerPlayable(layer)| function| Make it playable| | playerRemove(layer)| function| Remove Playing| | playerResume(layer)| function| Resume Playing| | playerStart(layer)| function| Start Playback| | playerStartBlk(layer)| function| Start Blocking Playback| | playerStop(layer)| function| Stop Playing| | playerUnmute(layer)| function| Unmute| | setPlayerAllowBlockingEvent(layer,value)| setter| Set "Allow Blocking Event" Parameter| | setPlayerBlocked(layer,value)| setter| Set "Blocked" Parameter| | setPlayerCounter(layer,value)| setter| Set "Counter" Parameter| | setPlayerDebugLogLevel(layer,value)| setter| Set "Debug Log Level" Parameter| | setPlayerFilename(layer,value)| setter| Set "Filename" Parameter| | setPlayerNoEvents(layer,value)| setter| Set "No Events" Parameter| | setPlayerPassthrough(layer,value)| setter| Set "Passthrough" Parameter| | setPlayerWatch(layer,value)| setter| Set "Watch" Parameter| | ttsBlockOnStop(layer)| function| Player Blocks on Stop|