Package com.wowza.wms.livestreamrecord.manager

Interface IStreamRecorderConstants

public interface IStreamRecorderConstants

Defines the static constants used by the StreamRecorder system
The Properties for StreamRecorders should be placed in application.xml within the StreamRecorder properties container

for example:
&lt/StreamRecorder&gt
&lt/Properties&gt
&lt/Property&gt
&lt/Name>streamRecorderDebugEnable&lt/Name&gt
&lt/Value>true&lt/Value&gt
&lt/Type>Boolean&lt/Type&gt
&lt/Property&gt
&nbsp&lt/Properties&gt
&lt/StreamRecorder&gt

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPEND_FILE	Appends new stream data to the existing file.
static final String	FORMAT_FLV
static final String	FORMAT_MP4
static final String	OVERWRITE_FILE	Overwrites the existing file with the new file
static final String	PROPERTY_BACK_BUFFER_TIME	Application Property "streamRecorderBackBufferTime": for specifying the number of milliseconds of packets to pull from the incoming stream buffer and write to file, before beginning the recording.
static final String	PROPERTY_DEBUG_ENABLE	Application Property "streamRecorderDebugEnable": for enabling additional log statements throughout StreamRecorder
static final String	PROPERTY_DEFAULT_AUDIO_SEARCH_POSITION	Application Property "streamRecorderDefaultAudioSearchPosition": for specifying how audio is found when it may not be in sync with the video
static final String	PROPERTY_FILE_FORMAT	Application Property "streamRecorderFileFormat": for specifying the default file format used by StreamRecorder.
static final String	PROPERTY_FILE_VERSION_DELEGATE	Application Property "streamRecorderFileVersionDelegate": for specifying a default custom file version delegate.
static final String	PROPERTY_FILE_VERSION_TEMPLATE	Application Property "streamRecorderFileVersionTemplate": for specifying a default file version template string.
static final String	PROPERTY_MOVE_FIRST_VIDEO_FRAME_TO_ZERO	Application Property "streamRecorderMoveFirstVideoFrameToZero": for specifying the default moveFirstVideoFrameToZero value used by StreamRecorder.
static final String	PROPERTY_NOTIFY_LISTENER	Application Property "streamRecorderNotifyListener": for specifying the default listener which will receive StreamRecorder notifications.
static final String	PROPERTY_OUTPUT_FILE	Application Property "streamRecorderOutputFile": for specifying the default filename used by StreamRecorder for recordings.
static final String	PROPERTY_OUTPUT_PATH	Application Property "streamRecorderOutputPath": for specifying the default path used by StreamRecorder to write recordings.
static final String	PROPERTY_RECORD_DATA	Application Property "streamRecorderRecordData": for specifying the default recordData value used by StreamRecorders.
static final String	PROPERTY_SEGMENT_DURATION	Application Property "streamRecorderSegmentDuration": for specifying the default SegmentDuration used by StreamRecorder when the segmentationType is set to SEGMENT_BY_DURATION.
static final String	PROPERTY_SEGMENT_SCHEDULE	Application Property "streamRecorderSegmentSchedule": for specifying the default SegmentSchedule string used by StreamRecorder when the segmentationType is set to SEGMENT_BY_SCHEDULE.
static final String	PROPERTY_SEGMENT_SIZE	Application Property "streamRecorderSegmentSize": for specifying the default SegmentSize used by StreamRecorder when the segmentationType is set to SEGMENT_BY_SIZE.
static final String	PROPERTY_SEGMENTATION_TYPE	Application Property "streamRecorderSegmentationType": for specifying the default segmentation type used by StreamRecorder.
static final String	PROPERTY_SKIP_KEYFRAME_AUDIO_TIMEOUT	Application Property "streamRecorderSkipKeyFrameUntilAudioTimeout": for specifying how long audio is waited for.
static final String	PROPERTY_SPLIT_ON_TC_DISCONTINUITY	Application Property "streamRecorderSplitOnTcDiscontinuity": for specifying the default splitOnTcDiscontinuity value used by StreamRecorder.
static final String	PROPERTY_START_ON_KEYFRAME	Application Property "streamRecorderStartOnKeyFrame": for specifying the default startOnKeyFrame value used by StreamRecorder.
static final String	PROPERTY_TIMESCALE	Application Property "streamRecorderTimescale": for specifying the timescale used when writing packets to a file.
static final String	PROPERTY_USE_SIMPLE_FILE_VERSION_NAMING	Application Property "streamRecorderUseSimpleFileVersionNaming": for using StreamRecorderSimpleFileVersionDelegate instead of StreamRecorderFileVersionDelegate as the default file version naming delegate
static final String	PROPERTY_VERSIONING_OPTION	Application Property "streamRecorderVersioningOption": for specifying the default file versioning method used by StreamRecorders
static final int	RECORDER_STATE_ERROR	Value returned by IStreamRecorder getRecorderState() to indicate an error has occurred in the recorder.
static final String	RECORDER_STATE_ERROR_STRING	String value returned by IStreamRecorder getRecorderStateString() when the recorder state is RECORDER_STATE_ERROR.
static final int	RECORDER_STATE_PENDING	Value returned by IStreamRecorder getRecorderState() to indicate the recorder has been created but it's IStreamRecorder startRecording() method has not yet been called.
static final String	RECORDER_STATE_PENDING_STRING	String value returned by IStreamRecorder getRecorderStateString() when the recorder state is RECORDER_STATE_PENDING.
static final int	RECORDER_STATE_RECORDING	Value returned by IStreamRecorder getRecorderState() to indicate the recorder is actively recording data to file.
static final String	RECORDER_STATE_RECORDING_STRING	String value returned by IStreamRecorder getRecorderStateString() when the recorder state is RECORDER_STATE_RECORDING.
static final int	RECORDER_STATE_WAITING	Value returned by IStreamRecorder getRecorderState() to indicate the recorder has been started but the associated stream is not currently being received by the server (for example the stream is not being published from the encoder)
static final String	RECORDER_STATE_WAITING_STRING	String value returned by IStreamRecorder getRecorderStateString() when the recorder state is RECORDER_STATE_WAITING.
static final String	SEGMENT_BY_DURATION
static final String	SEGMENT_BY_SCHEDULE
static final String	SEGMENT_BY_SIZE
static final String	SEGMENT_NONE
static final String	VERSION_FILE	Uses the file name returned by the configured fileVersionDelegate to version the new file

Field Details

PROPERTY_DEBUG_ENABLE

static final String PROPERTY_DEBUG_ENABLE

Application Property "streamRecorderDebugEnable": for enabling additional log statements throughout StreamRecorder

Add the property to the StreamRecorder Properties section of Application.xml.

Default value is false
Valid values are true or false

See Also:

• Constant Field Values

PROPERTY_USE_SIMPLE_FILE_VERSION_NAMING

static final String PROPERTY_USE_SIMPLE_FILE_VERSION_NAMING

Application Property "streamRecorderUseSimpleFileVersionNaming": for using StreamRecorderSimpleFileVersionDelegate instead of StreamRecorderFileVersionDelegate as the default file version naming delegate

Add the property to the StreamRecorder Properties section of Application.xml.

Default value is false
Valid values are true, false

See Also:

• StreamRecorderSimpleFileVersionDelegate
• Constant Field Values

PROPERTY_SEGMENTATION_TYPE

static final String PROPERTY_SEGMENTATION_TYPE

Application Property "streamRecorderSegmentationType": for specifying the default segmentation type used by StreamRecorder.

Add the property to the StreamRecorder Properties section of Application.xml.

Valid values are: none, schedule, size, duration

See Also:

• StreamRecorderParameters.segmentationType
• Constant Field Values

SEGMENT_NONE

static final String SEGMENT_NONE

See Also:

• Constant Field Values

SEGMENT_BY_SCHEDULE

static final String SEGMENT_BY_SCHEDULE

See Also:

• Constant Field Values

SEGMENT_BY_SIZE

static final String SEGMENT_BY_SIZE

See Also:

• Constant Field Values

SEGMENT_BY_DURATION

static final String SEGMENT_BY_DURATION

See Also:

• Constant Field Values

PROPERTY_FILE_FORMAT

static final String PROPERTY_FILE_FORMAT

Application Property "streamRecorderFileFormat": for specifying the default file format used by StreamRecorder.

Add the property to the StreamRecorder Properties section of Application.xml.

Valid values are: flv, mp4

See Also:

• StreamRecorderParameters.fileFormat
• Constant Field Values

FORMAT_FLV

static final String FORMAT_FLV

See Also:

• Constant Field Values

FORMAT_MP4

static final String FORMAT_MP4

See Also:

• Constant Field Values

PROPERTY_VERSIONING_OPTION

static final String PROPERTY_VERSIONING_OPTION

Application Property "streamRecorderVersioningOption": for specifying the default file versioning method used by StreamRecorders

Add the property to the StreamRecorder Properties section of Application.xml.

Valid values are: version, append, overwrite

See Also:

• StreamRecorderParameters.versioningOption
• Constant Field Values

VERSION_FILE

static final String VERSION_FILE

Uses the file name returned by the configured fileVersionDelegate to version the new file

See Also:

• IStreamRecorderFileVersionDelegate
• StreamRecorderFileVersionDelegate
• StreamRecorderSimpleFileVersionDelegate
• Constant Field Values

APPEND_FILE

static final String APPEND_FILE

Appends new stream data to the existing file. NOTE: To ensure playback compatibility, it is highly recommended that this option only be used if all streams recorded to the file will be using identical video and audio codecs and configurations.

See Also:

• Constant Field Values

OVERWRITE_FILE

static final String OVERWRITE_FILE

Overwrites the existing file with the new file

See Also:

• Constant Field Values

PROPERTY_START_ON_KEYFRAME

static final String PROPERTY_START_ON_KEYFRAME

Application Property "streamRecorderStartOnKeyFrame": for specifying the default startOnKeyFrame value used by StreamRecorder.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.startOnKeyFrame
• Constant Field Values

PROPERTY_RECORD_DATA

static final String PROPERTY_RECORD_DATA

Application Property "streamRecorderRecordData": for specifying the default recordData value used by StreamRecorders.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.recordData
• Constant Field Values

PROPERTY_MOVE_FIRST_VIDEO_FRAME_TO_ZERO

static final String PROPERTY_MOVE_FIRST_VIDEO_FRAME_TO_ZERO

Application Property "streamRecorderMoveFirstVideoFrameToZero": for specifying the default moveFirstVideoFrameToZero value used by StreamRecorder.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.moveFirstVideoFrameToZero
• Constant Field Values

PROPERTY_SPLIT_ON_TC_DISCONTINUITY

static final String PROPERTY_SPLIT_ON_TC_DISCONTINUITY

Application Property "streamRecorderSplitOnTcDiscontinuity": for specifying the default splitOnTcDiscontinuity value used by StreamRecorder.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.splitOnTcDiscontinuity
• Constant Field Values

PROPERTY_SEGMENT_SIZE

static final String PROPERTY_SEGMENT_SIZE

Application Property "streamRecorderSegmentSize": for specifying the default SegmentSize used by StreamRecorder when the segmentationType is set to SEGMENT_BY_SIZE.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.segmentSize
• Constant Field Values

PROPERTY_SEGMENT_DURATION

static final String PROPERTY_SEGMENT_DURATION

Application Property "streamRecorderSegmentDuration": for specifying the default SegmentDuration used by StreamRecorder when the segmentationType is set to SEGMENT_BY_DURATION.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.segmentDuration
• Constant Field Values

PROPERTY_SEGMENT_SCHEDULE

static final String PROPERTY_SEGMENT_SCHEDULE

Application Property "streamRecorderSegmentSchedule": for specifying the default SegmentSchedule string used by StreamRecorder when the segmentationType is set to SEGMENT_BY_SCHEDULE.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.segmentSchedule
• Constant Field Values

PROPERTY_OUTPUT_PATH

static final String PROPERTY_OUTPUT_PATH

Application Property "streamRecorderOutputPath": for specifying the default path used by StreamRecorder to write recordings.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.outputPath
• Constant Field Values

PROPERTY_OUTPUT_FILE

static final String PROPERTY_OUTPUT_FILE

Application Property "streamRecorderOutputFile": for specifying the default filename used by StreamRecorder for recordings.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.outputFile
• Constant Field Values

PROPERTY_BACK_BUFFER_TIME

static final String PROPERTY_BACK_BUFFER_TIME

Application Property "streamRecorderBackBufferTime": for specifying the number of milliseconds of packets to pull from the incoming stream buffer and write to file, before beginning the recording.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.backBufferTime
• Constant Field Values

PROPERTY_NOTIFY_LISTENER

static final String PROPERTY_NOTIFY_LISTENER

Application Property "streamRecorderNotifyListener": for specifying the default listener which will receive StreamRecorder notifications.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.notifyListener
• Constant Field Values

PROPERTY_FILE_VERSION_DELEGATE

static final String PROPERTY_FILE_VERSION_DELEGATE

Application Property "streamRecorderFileVersionDelegate": for specifying a default custom file version delegate.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.fileVersionDelegate
• Constant Field Values

PROPERTY_FILE_VERSION_TEMPLATE

static final String PROPERTY_FILE_VERSION_TEMPLATE

Application Property "streamRecorderFileVersionTemplate": for specifying a default file version template string. NOTE: only applicable when using the default fileVersionDelegate

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters.fileTemplate
• StreamRecorderParameters.fileVersionDelegate
• Constant Field Values

PROPERTY_TIMESCALE

static final String PROPERTY_TIMESCALE

Application Property "streamRecorderTimescale": for specifying the timescale used when writing packets to a file. It ONLY applies to MP4 file outputs. The only VALID values are 90000 or 100000

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters#streamRecorderTimescale
• Constant Field Values

PROPERTY_DEFAULT_AUDIO_SEARCH_POSITION

static final String PROPERTY_DEFAULT_AUDIO_SEARCH_POSITION

Application Property "streamRecorderDefaultAudioSearchPosition": for specifying how audio is found when it may not be in sync with the video

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters#streamRecorderDefaultAudioSearchPosition
• Constant Field Values

PROPERTY_SKIP_KEYFRAME_AUDIO_TIMEOUT

static final String PROPERTY_SKIP_KEYFRAME_AUDIO_TIMEOUT

Application Property "streamRecorderSkipKeyFrameUntilAudioTimeout": for specifying how long audio is waited for.

Add the property to the StreamRecorder Properties section of Application.xml.

See Also:

• StreamRecorderParameters#streamRecorderSkipKeyFrameUntilAudioTimeout
• Constant Field Values

RECORDER_STATE_ERROR

static final int RECORDER_STATE_ERROR

Value returned by IStreamRecorder getRecorderState() to indicate an error has occurred in the recorder.

See Also:

• RECORDER_STATE_ERROR_STRING
• Constant Field Values

RECORDER_STATE_PENDING

static final int RECORDER_STATE_PENDING

Value returned by IStreamRecorder getRecorderState() to indicate the recorder has been created but it's IStreamRecorder startRecording() method has not yet been called.

See Also:

• RECORDER_STATE_PENDING_STRING
• Constant Field Values

RECORDER_STATE_WAITING

static final int RECORDER_STATE_WAITING

Value returned by IStreamRecorder getRecorderState() to indicate the recorder has been started but the associated stream is not currently being received by the server (for example the stream is not being published from the encoder)

See Also:

• RECORDER_STATE_WAITING_STRING
• Constant Field Values

RECORDER_STATE_RECORDING

static final int RECORDER_STATE_RECORDING

Value returned by IStreamRecorder getRecorderState() to indicate the recorder is actively recording data to file.

See Also:

• RECORDER_STATE_RECORDING_STRING
• Constant Field Values

RECORDER_STATE_ERROR_STRING

static final String RECORDER_STATE_ERROR_STRING

String value returned by IStreamRecorder getRecorderStateString() when the recorder state is RECORDER_STATE_ERROR.

See Also:

• RECORDER_STATE_ERROR
• Constant Field Values

RECORDER_STATE_PENDING_STRING

static final String RECORDER_STATE_PENDING_STRING

String value returned by IStreamRecorder getRecorderStateString() when the recorder state is RECORDER_STATE_PENDING.

See Also:

• RECORDER_STATE_PENDING
• Constant Field Values

RECORDER_STATE_WAITING_STRING

static final String RECORDER_STATE_WAITING_STRING

String value returned by IStreamRecorder getRecorderStateString() when the recorder state is RECORDER_STATE_WAITING.

See Also:

• RECORDER_STATE_PENDING
• Constant Field Values

RECORDER_STATE_RECORDING_STRING

static final String RECORDER_STATE_RECORDING_STRING

String value returned by IStreamRecorder getRecorderStateString() when the recorder state is RECORDER_STATE_RECORDING.

See Also:

• RECORDER_STATE_RECORDING
• Constant Field Values