====== Media Recorder Layer (recorder) ====== This layer is used to record a media file. It can be placed on top of an RTP, SRTP, TTS, ASR, audio, generator or detector layer. ===== Media Recorder Layer Configuration Parameters ===== ^ Parameter^ Type^ Description^ | Alias| String| | | Debug Log Level| Number| Debug Level| | Dependencies| String| Other dependencies to this element| | Destination Peer| Number| | | Direction| Number| | | Event Filter| String| Filter of Event| | Exact Match| Boolean| | | Filename| Number| Filename| | Height| Number| Video Height Resolution| | 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| | | PESQ Player| Number| Player Name| | PESQ Reference| String| Reference Filename| | 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| | Record Audio| Boolean| Record Audio| | Record Video| Boolean| Record Video| | Request Timeout| Number| | | Save Dynamic Config| Boolean| | | Show Commands| Boolean| Show Commands| | Show Events| Boolean| Show Events| | Three Way| Boolean| Three Way Detection| | Watch| Boolean| Watch Layer| | Width| Number| Video Width Resolution| ===== Media Recorder Layer Real-Time Parameters ===== ^ Parameter^ Type^ Description^ | Allow Blocking Event| Boolean| Blocking Events| | Blocked| Boolean| Disable Component| | Debug Log Level| Number| Debug Level| | Destination| String| Filename full path| | Filename| String| Filename| | Frame Rate| Number| Video Frame Rate| | Height| Number| Video Height Resolution| | Max Instances| Number| Maximum Number of Instances of a Component| | PESQ Player| String| Player Name| | PESQ Reference| String| Reference Filename| | Passthrough| Boolean| High-to-Low Layer Passthrough| | Rate| Number| Sampling Rate (Samples/sec)| | Record Audio| Boolean| Record Audio| | Record Video| Boolean| Record Video| | Three Way| Boolean| Three Way Detection| | Watch| Boolean| Watch Layer| | Width| Number| Video Width Resolution| ===== Media Recorder Layer Functions ===== ^ Function^ Type^ Description^ | getRecorderAllowBlockingEvent(layer)| getter| Get "Allow Blocking Event" Parameter| | getRecorderBlocked(layer)| getter| Get "Blocked" Parameter| | getRecorderDebugLogLevel(layer)| getter| Get "Debug Log Level" Parameter| | getRecorderDestination(layer)| getter| Get "Destination" Parameter| | getRecorderDestinationPeer(layer)| getter| Get "Destination Peer" Parameter| | getRecorderDirection(layer)| getter| Get "Direction" Parameter| | getRecorderFilename(layer)| getter| Get "Filename" Parameter| | getRecorderFrameRate(layer)| getter| Get "Frame Rate" Parameter| | getRecorderHeight(layer)| getter| Get "Height" Parameter| | getRecorderMaxInstances(layer)| getter| Get "Max Instances" Parameter| | getRecorderNoEvents(layer)| getter| Get "No Events" Parameter| | getRecorderPESQPlayer(layer)| getter| Get "PESQ Player" Parameter| | getRecorderPESQReference(layer)| getter| Get "PESQ Reference" Parameter| | getRecorderPassthrough(layer)| getter| Get "Passthrough" Parameter| | getRecorderRate(layer)| getter| Get "Rate" Parameter| | getRecorderRecordAudio(layer)| getter| Get "Record Audio" Parameter| | getRecorderRecordVideo(layer)| getter| Get "Record Video" Parameter| | getRecorderThreeWay(layer)| getter| Get "Three Way" Parameter| | getRecorderWatch(layer)| getter| Get "Watch" Parameter| | getRecorderWidth(layer)| getter| Get "Width" Parameter| | getStatsRecorderAvailableInstances(layer)| getter| Get "Available Instances" Parameter| | getStatsRecorderDownstreamLastPacket(layer)| getter| Get "Downstream Last Packet" Parameter| | getStatsRecorderDownstreamPacketCount(layer)| getter| Get "Downstream Packet Count" Parameter| | getStatsRecorderMaxDownstreamDelay(layer)| getter| Get "Max Downstream Delay" Parameter| | getStatsRecorderMaxUpstreamDelay(layer)| getter| Get "Max Upstream Delay" Parameter| | getStatsRecorderMeanDownstreamDelay(layer)| getter| Get "Mean Downstream Delay" Parameter| | getStatsRecorderMeanUpstreamDelay(layer)| getter| Get "Mean Upstream Delay" Parameter| | getStatsRecorderMinDownstreamDelay(layer)| getter| Get "Min Downstream Delay" Parameter| | getStatsRecorderMinUpstreamDelay(layer)| getter| Get "Min Upstream Delay" Parameter| | getStatsRecorderName(layer)| getter| Get "Name" Parameter| | getStatsRecorderPESQScore(layer)| getter| Get "PESQ Score" Parameter| | getStatsRecorderRateBpsDownstream(layer)| getter| Get "Rate Bps Downstream" Parameter| | getStatsRecorderRateBpsUpstream(layer)| getter| Get "Rate Bps Upstream" Parameter| | getStatsRecorderTimestampIn(layer)| getter| Get "Timestamp In" Parameter| | getStatsRecorderTimestampOut(layer)| getter| Get "Timestamp Out" Parameter| | getStatsRecorderType(layer)| getter| Get "Type" Parameter| | getStatsRecorderUpstreamLastPacket(layer)| getter| Get "Upstream Last Packet" Parameter| | getStatsRecorderUpstreamPacketCount(layer)| getter| Get "Upstream Packet Count" Parameter| | getStatsRecorderVarianceDownstreamDelay(layer)| getter| Get "Variance Downstream Delay" Parameter| | getStatsRecorderVarianceUpstreamDelay(layer)| getter| Get "Variance Upstream Delay" Parameter| | recorderRecord(layer)| function| Force Recording| | recorderStart(layer)| function| Start Recording| | recorderStartPESQ(layer)| function| Start PESQ Computation| | recorderStop(layer)| function| Stop Recording| | recorderStopPESQ(layer)| function| Stop PESQ Computation| | setRecorderAllowBlockingEvent(layer,value)| setter| Set "Allow Blocking Event" Parameter| | setRecorderBlocked(layer,value)| setter| Set "Blocked" Parameter| | setRecorderDebugLogLevel(layer,value)| setter| Set "Debug Log Level" Parameter| | setRecorderDirection(layer,value)| setter| Set "Direction" Parameter| | setRecorderFilename(layer,value)| setter| Set "Filename" Parameter| | setRecorderHeight(layer,value)| setter| Set "Height" Parameter| | setRecorderNoEvents(layer,value)| setter| Set "No Events" Parameter| | setRecorderPESQReference(layer,value)| setter| Set "PESQ Reference" Parameter| | setRecorderPassthrough(layer,value)| setter| Set "Passthrough" Parameter| | setRecorderRecordAudio(layer,value)| setter| Set "Record Audio" Parameter| | setRecorderRecordVideo(layer,value)| setter| Set "Record Video" Parameter| | setRecorderWatch(layer,value)| setter| Set "Watch" Parameter| | setRecorderWidth(layer,value)| setter| Set "Width" Parameter|