UniMRCP  1.7.0
Data Fields
mrcp_recorder_header_t Struct Reference

#include <mrcp_recorder_header.h>

Collaboration diagram for mrcp_recorder_header_t:
Collaboration graph
[legend]

Data Fields

float sensitivity_level
 
apr_size_t no_input_timeout
 
mrcp_recorder_completion_cause_e completion_cause
 
apt_str_t completion_reason
 
apt_str_t failed_uri
 
apt_str_t failed_uri_cause
 
apt_str_t record_uri
 
apt_str_t media_type
 
apr_size_t max_time
 
apr_size_t trim_length
 
apr_size_t final_silence
 
apt_bool_t capture_on_speech
 
apt_bool_t ver_buffer_utterance
 
apt_bool_t start_input_timers
 
apt_bool_t new_audio_channel
 

Detailed Description

MRCP recorder-header

Field Documentation

◆ capture_on_speech

apt_bool_t mrcp_recorder_header_t::capture_on_speech

f false, the recorder MUST start capturing immediately when started. If true, the recorder MUST wait for the endpointing functionality to detect speech before it starts capturing

◆ completion_cause

mrcp_recorder_completion_cause_e mrcp_recorder_header_t::completion_cause

MUST be part of a RECORD-COMPLETE event coming from the recorder resource to the client

◆ completion_reason

apt_str_t mrcp_recorder_header_t::completion_reason

MAY be specified in a RECORD-COMPLETE event coming from the recorder resource to the client

◆ failed_uri

apt_str_t mrcp_recorder_header_t::failed_uri

When a recorder method needs to post the audio to a URI and access to the URI fails, the server MUST provide the failed URI in this header in the method response

◆ failed_uri_cause

apt_str_t mrcp_recorder_header_t::failed_uri_cause

When a recorder method needs to post the audio to a URI and access to the URI fails, the server MUST provide the URI specific or protocol specific response code through this header in the method response

◆ final_silence

apr_size_t mrcp_recorder_header_t::final_silence

When recorder is started and the actual capture begins, this header specifies the length of silence in the audio that is to be interpreted as the end of the recording

◆ max_time

apr_size_t mrcp_recorder_header_t::max_time

When recording is started this specifies the maximum length of the recording in milliseconds, calculated from the time the actual capture and store begins and is not necessarily the time the RECORD method is received

◆ media_type

apt_str_t mrcp_recorder_header_t::media_type

A RECORD method MUST contain this header, which specifies to the server the Media Type of the captured audio or video

◆ new_audio_channel

apt_bool_t mrcp_recorder_header_t::new_audio_channel

MAY be specified in a RECORD request and allows the client to tell the server that, from this point on, further input audio comes from a different audio source

◆ no_input_timeout

apr_size_t mrcp_recorder_header_t::no_input_timeout

When recording is started and there is no speech detected for a certain period of time, the recorder can send a RECORD-COMPLETE event

◆ record_uri

apt_str_t mrcp_recorder_header_t::record_uri

When a recorder method contains this header the server must capture the audio and store it

◆ sensitivity_level

float mrcp_recorder_header_t::sensitivity_level

To filter out background noise and not mistake it for speech

◆ start_input_timers

apt_bool_t mrcp_recorder_header_t::start_input_timers

MAY be sent as part of the RECORD request. A value of false tells the recorder resource to start the operation, but not to start the no-input timer until the client sends a START-INPUT-TIMERS

◆ trim_length

apr_size_t mrcp_recorder_header_t::trim_length

This header MAY be sent on a STOP method and specifies the length of audio to be trimmed from the end of the recording after the stop

◆ ver_buffer_utterance

apt_bool_t mrcp_recorder_header_t::ver_buffer_utterance

Tells the server to buffer the utterance associated with this recording request into the verification buffer


The documentation for this struct was generated from the following file: