Parameter identifiers
The parameter identifiers are constant strings declared in the include files of the package (see Filter configuration through IDatasteadRtspSourceConfig).
- the Identifier column is the name of the identifier that can be passed as parameter from the IDatasteadRtspSourceConfig interface. The type suffix of the name (
_str,_int,_bool,_double,_int64,_intptr) reminds the corresponding Get.../Set... function to invoke, - the url param column, if it exists, is the name of this parameter when it is passed alternatively at the end of the URL (instead of using IDatasteadRtspSourceConfig), e.g.:
rtsp://192.168.0.25/axis-media/media.amp?videocodec=h264&audio=1>recordingfilename=c:\folder\test.mp4
Actions
| Identifier | Description |
|---|---|
| RTSP_Action_OpenURL | Sets the URL and connects the filter synchronously. This function must be invoked while configuring the filter, at last, after setting all the optional parameters, if needed. Returns S_OK upon success. |
| RTSP_Action_OpenURLAsync | Sets the URL and initiates the connection, but returns immediately without waiting for the connection to complete. The filter connects in the background and notifies when the connection completes through the IMediaEventEx notification (EC_RTSPNOTIFY with param1 = EC_RTSP_PARAM1_OPENURLASYNC_CONNECTION_RESULT, param2 = 1 on success, 0 on failure) or through the callback configured with SetAsyncOpenURLCallback. You must wait for the notification before trying to render the pins, because the pin formats are not available until the connection is completed. |
| RTSP_Action_IsURLResponding | Tests if the source is live, without starting the URL decoding. Returns S_OK upon success. |
| RTSP_Action_GetONVIFSnapshot | Captures synchronously a snapshot from an ONVIF URL (see ONVIF JPEG snapshot). |
| RTSP_Action_GetONVIFSnapshotAsync | Captures asynchronously a snapshot from an ONVIF URL (see ONVIF JPEG snapshot). |
| RTSP_Action_GetONVIFInfo | Opens the ONVIF URL and gets the ONVIF settings, without starting the live stream. You can then invoke the GetStr (RTSP_ONVIF_Info...) functions to read the ONVIF settings. |
| RTSP_Action_RecordToNewFileNow | Closes the current file being written and starts writing to a new file specified as parameter. The new file must have the same extension than the previous one. If no file name is specified as parameter, the current file is closed, reopened and overwritten. To temporarily suspend the recording without stopping the graph, pass a file name having the same extension and "nul" as name (e.g. nul.mp4, as is, without file path); the recording remains suspended until you pass a new valid file name. This action applies only while the graph is running and recording. |
| RTSP_Action_CancelPendingConnection | Cancels a pending URL connection, previously initiated by RTSP_Action_OpenURLAsync. It can be invoked e.g. when exiting the application, just before clearing the graph, to ensure any pending connection is cancelled immediately. |
| RTSP_Action_PauseURL | Pauses the video stream. |
| RTSP_Action_ResumeURL | Resumes the video stream. |
| RTSP_Action_PauseRecording | Pauses the recording of the current file, while the preview keeps running. |
| RTSP_Action_ResumeRecording | Resumes the recording of the current file, if previously paused. |
| RTSP_Action_CaptureFrame | Captures a frame as snapshot. The format depends on the Option parameter. File name: the next frame is captured in the format specified by the extension (BMP, TIFF, PNG, JPG), e.g. Action (RTSP_Action_CaptureFrame, "c:\folder\nextimage.jpg"). "HBITMAP" keyword: the next frame is captured to a bitmap handle, returned by an EC_RTSPNOTIFY (EC_RTSP_PARAM1_FRAME_CAPTURE_SUCCEEDED, BitmapHandle) notification event (do not delete the bitmap handle, it may be reused for the next capture and will be released by the filter). |
| RTSP_Action_UpdateDuration | Reserved. |
Source URL
| Identifier | url param | Description |
|---|---|---|
| RTSP_Source_RecordingFileName_str | recordingfilename | Sets the recording file name. Setting this property enables the recording of the stream to a file. The extension determines the format (mp4, flv, mov, avi, mkv). To configure the filter in recording mode without starting immediately the recording, set a nul file name without path with the desired extension (e.g. nul.mp4), then invoke Action (RTSP_Action_RecordToNewFileNow, realfilename) when it is time to write. Remarks: the filter does not include an H264 encoder, it just saves the native H264 samples to the recording file; if the audio recording is enabled, it encodes the audio stream to PCM, MP3 or AAC depending on the recording format selected; if the recording file name is set while the filter is running, this closes the current file being recorded and starts saving to a new file on the fly. |
| RTSP_Source_RecordingBacktimedStartSeconds_int | backtimedstart | See Backtimed recording. |
| RTSP_Source_Recording_Title_str | title | Sets a title for the video clip (for containers that support this feature, like MP4). |
| RTSP_Source_PlayableWhileRecording_int | playablewhilerecording | 0: the clip is not playable while recording (default). 1: the clip is playable while recording if the container supports this possibility (like MP4 or ASF). 2: idem, different mode. |
| RTSP_Source_ContinuousRecording_bool | continuousrecording | When enabled, the recording does not stop when the graph is stopped / restarted. The recording stops only when the graph is destroyed (default: disabled). |
| RTSP_Source_MaxAnalyzeDuration_int | maxanalyzeduration | Maximum duration of the analysis of the stream during the initial connection, expressed in milliseconds, e.g. ">maxanalyzeduration=1000". |
| RTSP_Source_FindFPSFrameCount_int | findfpsframecount | Number of frames used to analyze the fps when it is not reported by the camera at connection time. Default value: 40 frames. With lower values the connection will be faster but there is more chance the FPS reported is inaccurate; with higher values the FPS reported will be more accurate but the connection will take longer. |
| RTSP_Source_FastConnect_bool | fastconnect | Enables the fast connection mode. 0: disabled (default), 1: enabled. May increase the memory consumption. E.g. rtsp://192.168.5.22/live.sdp>fastconnect=1 |
| RTSP_Source_AutoReconnect_bool | autoreconnect | Enables/disables the automatic reconnection of the filter. Default: enabled. See Auto reconnection. |
| RTSP_Source_RetryInitialConnect_int | retryinitialconnect | When connecting asynchronously and the URL is not available, the filter retries to connect to the URL. 0: disabled (default), -1: retries indefinitely, 1..n: retries the specified number of times. The duration of each retry depends on the RTSP_Source_ConnectionTimeOut_int parameter expressed in milliseconds. |
| RTSP_Source_CopyTimestamps_bool | copyts | When enabled, the timestamps of the source are copied "as is": from the input stream to the output pins (when decoding), and from the input stream to the output stream of the file being recorded (when recording). Note: in this mode it is not possible to record to a new file "on the fly" without stopping/restarting the filter. |
| RTSP_Source_NoTranscoding_bool | notranscoding | Records the audio stream "as is", instead of recompressing it to AAC. Default: false. |
| RTSP_Source_DeviceLostTimeOut_int | devicelosttimeout | If no frame is received after this timeout (expressed in milliseconds) the auto reconnection (if autoreconnect=1) or device lost event (if autoreconnect=0) occurs (see Auto reconnection). Default: 10 sec. (10000). |
| RTSP_Source_BufferDuration_int | buffer | Specifies the buffering duration in milliseconds. Default: 0 if no audio, 1000 milliseconds if audio. |
| RTSP_Source_SampleDeliveryMode_int | sampledeliverymode | Reserved. |
| RTSP_Source_TimestampDelayMs_int | timestampdelayms | Adds (or removes if negative) the specified latency to the sample timestamps of the output pins. |
| RTSP_Source_ConnectionTimeOut_int | timeout | Connection timeout in milliseconds. Default: 20000 (20 seconds). |
| RTSP_Source_RTSPTransport_int | rtsptransport | RTSP transport mode. 0: automatic, 1: tcp, 2: udp, 3: http, 4: udp_multicast, 5: https. See RTSP transport. |
| RTSP_Source_RTSPRange_str | rtsprange | Optional RTSP range specification (e.g. to start playing a clip stored on the RTSP source at the specified date/time). E.g.: ">rtsprange=clock=20150217T153000Z-". |
| RTSP_Source_UDP_LocalAddr_str | localaddr | Local IP address of a network interface used for sending packets or joining multicast groups. |
| RTSP_Source_UDP_LocalPort_int | localport | Overrides the local UDP port to bind with. |
| RTSP_Source_HTTPProxy_str | httpproxy | Specifies the http proxy to use, if needed, for the http/https URLs. Syntax without authentication: http://IP:port. Syntax with authentication: http://user:passwd@IP:port. E.g. as url parameter: >httpproxy=http://proxyuser:proxypass@192.168.1.38:9000. |
| RTSP_Source_MpegTS_Program_str | program | In a MPEG-TS stream with several programs, specifies the name of the program to use (by default the 1st program found is used). |
| RTSP_Source_Format_str | srcformat | Used to specify the input format for some HTTP URLs if the filter does not detect them properly. Possible values: "mjpeg" (IP camera, HTTP in JPG or MJPEG mode), "mxg" (IP camera, HTTP in MXPEG mode), "jpeg:WidthxHeight" (specifies the image dimensions when the RTSP stream is a MJPEG stream and the size is not properly detected by the filter). |
| RTSP_Source_Playback_Speed_Ratio_double | playspeedratio | For the URLs having a fixed duration, specifies the playback speed. E.g. to play the clip at half speed: >playspeedratio=0.5. |
| RTSP_Source_Axis_IrCutFilter_str | Sets or retrieves the state of the IR Cut Filter of Axis cameras. Supported values: "enabled" / "disabled" / "auto". | |
| RTSP_Source_AverageTimePerFrame100ns_int | Retrieves the average time per video frame, expressed in 100ns units. | |
| RTSP_Source_DurationMs_int | Retrieves the duration of the clip or URL, if any (if the source is not a live source), expressed in milliseconds. | |
| RTSP_Source_Duration100ns_int64 | Retrieves the duration of the clip or URL, if any (if the source is not a live source), expressed in 100 ns units. | |
| RTSP_Source_AuthUser_str | Authentication user name, if required. | |
| RTSP_Source_AuthPassword_str | Authentication password, if required. | |
| RTSP_Source_StreamInfo_str | Retrieves information about the streams. Note: this is a "displayable" multi-line string, each line separated by CR/LF characters. | |
| RTSP_Source_StreamInfo_as_XML_str | Retrieves information about the streams as XML text. | |
| RTSP_Source_Metadata_str | Retrieves the metadata as a string made of values separated by CR/LF characters. | |
| RTSP_Source_StartTime_int | starttime | If the source URL supports seeking, you can specify the start time expressed in milliseconds. E.g. if the start time should be 2 min 30 sec → 150 seconds = 150000 milliseconds: SetInt ("RTSP_Source_StartTime_int", 150000). |
| RTSP_Source_Threads_int | threads | Number of threads assigned to the decoding (and eventually encoding) of the source. Default: 1. 0: auto. |
| RTSP_Source_ThreadPriority_int | threadpriority | Sets the priority of the decoding threads. 0: THREAD_PRIORITY_NORMAL (default), 1: THREAD_PRIORITY_ABOVE_NORMAL, 2: THREAD_PRIORITY_HIGHEST, 3: THREAD_PRIORITY_TIME_CRITICAL. |
| RTSP_Source_IsURLConnected_bool | Returns true if the URL is connected. It returns false if the URL is not yet connected, or if the URL is reconnecting when AutoReconnect is enabled. | |
| RTSP_Source_GetAudioDevices_str | Retrieves the list of the DirectShow audio capture devices (microphone, line input, webcam mic., etc...) currently available on the PC. It is returned as a "displayable" string that contains the devices separated by a "\n" (line feed, chr(10)) character. | |
| RTSP_Source_SetAudioDevice_str | Sets the name of the audio capture device to use. The name must be one of the names returned by GetStr (RTSP_Source_GetAudioDevices_str, ...). Setting this property invalidates the audio of the RTSP source or IP camera (if any), and selects the use of the specified audio capture device instead. | |
| RTSP_Source_GetURL_str | Retrieves the current URL. | |
| RTSP_Source_GetState_int | Returns the current source state. Possible values include: state_disconnected, state_connecting_async, state_connecting_sync, state_reconnecting, state_connected, state_previewing, state_recording_paused, state_recording_active. |
ONVIF related
These parameters require to be connected with an onvif://... URL syntax.
| Identifier | url param | Description |
|---|---|---|
| RTSP_ONVIF_Authentication_TimeOffsetMode_int | authmode | 0: authentication with time offset disabled first, then if it fails, authentication with time offset checking. 1: authenticates without time offset checking. 2: authenticates with time offset checking. 3: authentication with time offset first, then if it fails, authentication without time offset checking. |
| RTSP_ONVIF_Media_Version_int | mediaversion | Used to specify whether the ONVIF Media1 (VER10) or Media2 (VER20) version should be used to query the ONVIF media information. 0: (default) uses both methods, returns profile information from the media version reporting the higher number of profiles. 1: uses Media1 (VER10). 2: uses Media2 (VER20). |
| RTSP_ONVIF_LastJPEGSnapshotBuffer_intptr | Returns a pointer to the memory buffer containing the last ONVIF JPEG snapshot. | |
| RTSP_ONVIF_LastJPEGSnapshotSize_int | Returns the size of the memory buffer containing the last ONVIF JPEG snapshot. | |
| RTSP_ONVIF_Info_As_XML_str | Returns all the ONVIF information gathered (manufacturer, model, serial, recordings available, etc...) in XML format. | |
| RTSP_ONVIF_Replay_As_XML_str | Retrieves the list of the recordings available with their replay URLs in XML format (see ONVIF replay). | |
| RTSP_ONVIF_Info_Manufacturer_str | Retrieves the name of the manufacturer of the IP camera or DVR. | |
| RTSP_ONVIF_Info_Model_str | Retrieves the model of the IP camera or DVR. | |
| RTSP_ONVIF_Info_HardwareId_str | Retrieves the hardware identifier of the IP camera or DVR. | |
| RTSP_ONVIF_Info_SerialNumber_str | Retrieves the serial number of the IP camera or DVR. | |
| RTSP_ONVIF_Info_FirmwareVersion_str | Retrieves the firmware version of the IP camera or DVR. | |
| RTSP_ONVIF_Info_PTZInfo_str | Retrieves the PTZ information of the IP camera or DVR, as a string of values separated by CR/LF characters. | |
| RTSP_ONVIF_Info_PTZLimits_str | Retrieves the min/max values of Pan, Tilt or Zoom of the IP camera, as a string of values separated by CR/LF characters. | |
| RTSP_ONVIF_Info_PTZPresets_str | Retrieves the list of the presets of the IP camera, as a string of values separated by CR/LF characters. | |
| RTSP_ONVIF_Info_MacAddress_str | Retrieves the MAC address of the network interface of the camera. | |
| RTSP_ONVIF_Info_AuxiliaryCommands_str | Retrieves the list of the auxiliary commands available for this camera, as a string made of words separated by "\r\n" characters. |
Video encoding
If specified, re-encodes with a different video codec than the native codec of the video source. Requires more CPU.
| Identifier | url param | Description |
|---|---|---|
| RTSP_VideoEncoder_Codec_str | vcodec | Specifies a video codec, to record in a different format, video size or bitrate (instead of the native codec format), e.g. "h264". |
| RTSP_VideoEncoder_BitRateKbps_int | vbitrate | Specifies the bitrate expressed in Kbps, if a video codec has been specified for the recording (see RTSP_VideoEncoder_Codec_str). |
| RTSP_VideoEncoder_QualityMin_int | vqualitymin | If specified and greater than 0, enables the VBR mode and specifies a minimal quality value that depends on the codec, usually in the 0..51 range or 12..42 range (for OpenH264). Note: lower value = higher quality. |
| RTSP_VideoEncoder_QualityMax_int | vqualitymax | If specified and greater than 0, enables the VBR mode and specifies a maximal quality value that depends on the codec, usually in the 0..51 range or 12..42 range (for OpenH264). Note: lower value = higher quality. |
| RTSP_VideoEncoder_GopSize_int | vgopsize | Specifies the key frame spacing (e.g. a GOP of 30 at 30fps creates a key frame every 30 frames). |
| RTSP_VideoEncoder_Profile_str | vprofile | Specifies a profile name for the encoder (e.g. "baseline" for H264). |
| RTSP_VideoEncoder_Cabac_bool | vcabac | Enables the cabac mode for the encoder (context-adaptive coding). |
| RTSP_VideoEncoder_Width_int | vwidth | Specifies the video width for the encoder. |
| RTSP_VideoEncoder_Height_int | vheight | Specifies the video height for the encoder. |
Audio encoding
| Identifier | url param | Description |
|---|---|---|
| RTSP_AudioEncoder_Codec_str | acodec | Specifies a codec name for the audio encoding, e.g. "aac", "mp3", ... |
| RTSP_AudioEncoder_BitRateKbps_int | abitrate | Specifies a bitrate in Kbps for the audio encoding. |
| RTSP_AudioEncoder_SampleRate_int | asamplerate | Specifies a sample rate for the audio encoding (e.g. 44100, 22050, etc...). |
Video output pin
| Identifier | url param | Description |
|---|---|---|
| RTSP_VideoStream_Enabled_bool | videostreamenabled | Enables/disables the video decompression and the rendering of the video pin. Default: true. |
| RTSP_VideoStream_Synchronized_bool | vidsync | If disabled, the filter removes the sample times, so the samples are rendered as fast as possible (the samples are not scheduled for rendering). Default: true. |
| RTSP_VideoStream_Recorded_bool | videostreamrecorded | If the recording is enabled (by setting RTSP_Source_RecordingFileName_str) and the URL outputs audio and video, allows to record audio only by disabling the recording of the video stream. Default: true. |
| RTSP_VideoStream_Sync_Start_Recording_bool | syncstart | Starts the recording synchronized with the decoded frames displayed. Enabling this feature enables automatically the recompression with the same codec. To recompress with a different codec, specify the codec name with RTSP_VideoEncoder_Codec_str. It is possible to enable the GPU encoding with RTSP_VideoStream_GPUEncoder_int. |
| RTSP_VideoStream_Decode_KeyFrames_Only_bool | keyframesonly | If set to true, only I-Frames are decoded. Can be enabled/disabled on the fly without stopping/restarting the graph. Saves decoding CPU by previewing at 1 fps or so, depending on the GOP size (key frame spacing). Default: false. Can be enabled through the URL by adding >keyframesonly=1. See also How can I reduce the CPU load? |
| RTSP_VideoStream_Index_int | videostreamindex | If the URL outputs more than 1 video stream, you can specify the index of the video stream to use (in the 0..n-1 range). Default: 0. |
| RTSP_VideoStream_MpegTS_pid_str | vpid | In a MPEG-TS stream with several video streams, specifies the PID of the video stream to use (by default the 1st video stream found is used). |
| RTSP_VideoStream_PinFormat_str | videopinformat | By default the video pin can connect in RGB32 or RGB24 format. This property allows to force one of the following pin formats (not case-sensitive): RGB32, RGB24, RGB565, RGB555, NV12, UYVY, I420. |
| RTSP_VideoStream_Width_int | width | Used to specify a non-default frame width for the video pin. Note: when the URL is connected, GetInt(RTSP_VideoStream_Width_int, Value) returns the video width of the decoded video stream. |
| RTSP_VideoStream_Height_int | height | Used to specify a non-default frame height for the video pin. Note: when the URL is connected, GetInt(RTSP_VideoStream_Height_int, Value) returns the video height of the decoded video stream. |
| RTSP_VideoStream_AspectRatio_double | aspectratio | Specifies how the aspect ratio of the video output pin is handled. 0.0 → applies the aspect ratio of the stream format, if specified. 1.0 → uses the width and height of the native video frame, "as is". Other values → applies the aspect ratio specified. |
| RTSP_VideoStream_TopDown_bool | Makes the image of the video output pin "top down". | |
| RTSP_VideoStream_MaxFrameRate_double | maxframerate | Used to limit the frame rate of the video pin. If this parameter is not specified the frame rate is the native frame rate of the video stream. The value is relevant only if it is lower than the frame rate of the video pin. See also RTSP_VideoStream_Decode_KeyFrames_Only_bool. |
| RTSP_VideoStream_Filter_str | videofilter | Specifies a FFmpeg video filter to use, e.g. hflip for a horizontal flipping, vflip for a top-down image (see Video processing). Note: depending on the context, some filters may not be usable. |
| RTSP_VideoStream_HWAcceleration_int | hwaccel | Enables the GPU-accelerated decoding. 0: software decoding, 1: dxva2 acceleration, 2: Intel GPU (QuickSync) — lowest memory consumption, 3: NVidia GPU (CUVID), 4: AMD AMF, 5: auto (whatever available: QuickSync, NVidia or AMD). |
| RTSP_VideoStream_HWAccelerationDevice_int | hwdevice | When RTSP_VideoStream_HWAcceleration_int is enabled, specifies the index of the GPU device (in the [0..n-1] range). Useful only if more than 1 GPU is available. |
| RTSP_VideoStream_GPUEncoder_int | gpuenc | Enables the hardware-accelerated encoding through the GPU when the recompression is enabled (the recompression is enabled by specifying a codec name with RTSP_VideoEncoder_Codec_str or by adding e.g. ">vcodec=h264" at the end of the URL). 0: software encoding, 1: auto select GPU, 2: Intel QSV GPU, 3: NVidia NVENC GPU, 4: AMD AMF GPU. |
| RTSP_VideoStream_Deinterlacing_int | deint | Enables the deinterlacing. 0: no deinterlacing (default), 1: yadif deinterlacing, 2: w3fdif deinterlacing (consumes more CPU). |
| RTSP_VideoStream_ConfigureTextOverlay_str | textoverlay | Enables a text overlay. To enable more than one overlay, invoke the function more than one time with a different overlay ID. Note: the overlay(s) must be enabled before loading the URL. If they must not be displayed immediately, set an empty string, then update it while the filter is running. The syntax is explained in the Text overlays chapter. |
| RTSP_VideoStream_ConfigureHueBrightSat_str | brighthuesat | Enables the brightness/hue/saturation adjustment. Note: must be enabled before loading the URL. If it must not be applied immediately, set the default values (b=0, h=0, s=1), then update them while the filter is running. The syntax is explained in the Text overlays and brightness/hue/saturation chapter. |
| RTSP_VideoStream_DelayMs_int | videodelay | Adds the specified latency (in milliseconds) to the video stream, relatively to the audio stream. Designed to have "manual" control over the audio/video sync. |
Audio output pin
| Identifier | url param | Description |
|---|---|---|
| RTSP_AudioStream_Enabled_bool | audiostreamenabled | Enables/disables the audio decompression and the rendering of the audio pin. Default: true. |
| RTSP_AudioStream_Recorded_bool | audiostreamrecorded | If the recording is enabled (by setting RTSP_Source_RecordingFileName_str) and the URL outputs audio and video, allows to record video only by disabling the recording of the audio stream. Default: true. |
| RTSP_AudioStream_Index_int | audiostreamindex | If the URL outputs more than 1 audio stream, you can specify the index of the audio stream to use (in the 0..n-1 range). Default: 0. |
| RTSP_AudioStream_SamplesPerSec_int | audiosamplespersec | Specifies the number of audio samples per second of the output pin. Values supported: 8000, 11025, 22050, 32000, 44100, 48000. Default: 44100. |
| RTSP_AudioStream_MpegTS_pid_str | apid | In a MPEG-TS stream with several audio streams, specifies the PID of the audio stream to use (by default the 1st audio stream found is used). |
| RTSP_AudioStream_Filter_str | audiofilter | Specifies a FFmpeg audio filter to use. Note: depending on the context, some filters may not be usable. |
| RTSP_AudioStream_Volume_int | audiovolume | Specifies a non-default audio volume, in the 0..65535 range (0 = muted). |
| RTSP_AudioStream_DelayMs_int | audiodelay | Adds the specified latency (in milliseconds) to the audio stream, relatively to the video stream. Designed to have "manual" control over the audio/video sync. |
Frame capture
| Identifier | url param | Description |
|---|---|---|
| RTSP_FrameCapture_Width_int | framecapturewidth | Specifies a non-default width for the next captured frame (by default the native width of the video frame is used). |
| RTSP_FrameCapture_Height_int | framecaptureheight | Specifies a non-default height for the next captured frame (by default the native height of the video frame is used). |
| RTSP_FrameCapture_Time_int | framecapturetime | Schedules the stream time the next frame will be captured, expressed in milliseconds. |
| RTSP_FrameCapture_FileName_str | framecapturefilename | Specifies the full path and file name of the next frame to capture. The extension specifies the format, the supported formats are: BMP, JPG, PNG, TIFF, e.g. "c:\folder\nextframe.png". |
Recording progress
| Identifier | Description |
|---|---|
| RTSP_CurrentRecording_FileSizeKb_int | Returns the file size progress (in Kb) of the current recording. |
| RTSP_CurrentRecording_ClipDurationMs_int | Returns the duration in milliseconds of the current recording. |
| RTSP_CurrentRecording_VideoFrameCount_int | Returns the video frame count of the current recording. |
| RTSP_CurrentRecording_FileName_str | Returns the file name of the current recording. |
| RTSP_LastRecorded_FileSizeKb_int | Returns the file size in Kb of the last file recorded. |
| RTSP_LastRecorded_ClipDurationMs_int | Returns the duration in milliseconds of the last file recorded. |
| RTSP_LastRecorded_VideoFrameCount_int | Returns the video frame count of the last file recorded. |
| RTSP_LastRecorded_FileName_str | Returns the name of the last file recorded. |
Re-streaming
Destination URL, encoding format of the destination URL (see Re-streaming).
| Identifier | url param | Description |
|---|---|---|
| RTSP_Dest_URL_str | desturl | Sets the re-streaming URL. Examples (at the end of the source URL): RTSP server on port 6000 (the IP address is the address of a network card on the PC running the filter): >desturl=rtspsrv://192.168.0.25:6000; UDP unicast on port 5000 (the IP address is the IP address of the client PC): >desturl=udp://192.168.0.200:5000; UDP multicast on port 4000: >desturl=udp://239.255.0.10:4000. Programmatical example: SetStr ("RTSP_Dest_URL_str", "rtspsrv://192.168.0.25:6000"). |
| RTSP_Dest_Video_BitRate_int | destvideobitrate | Sets the re-streaming video bit rate expressed in kb/s. |
| RTSP_Dest_Video_KeyFrameInterval_int | destvideokeyframeinterval | Sets the key frame spacing (default 30). |
Misc.
| Identifier | url param | Description |
|---|---|---|
| RTSP_Filter_Last_Error_Message_str | Returns information about the origin of the error that occurred when the connection to the URL failed. | |
| RTSP_Release_HBITMAP_int64 | Invoke SetInt64 (RTSP_Release_HBITMAP_int64, handle) to release a memory bitmap previously allocated by invoking Action (RTSP_Action_CaptureFrame, "HBITMAP"). |
|
| RTSP_Recording_MP4TagTimeUTC_bool | mp4tagutc | If enabled, the tag time of the MP4 file is set as UTC to be Quicktime-compliant. If disabled, the tag time of the MP4 file is set as local time, to be EXIF-compliant. Default: disabled. |
| RTSP_Filter_Version_int | Returns the filter version number. | |
| RTSP_Filter_Version_str | Returns the filter version as string. | |
| RTSP_Filter_Build_int | Returns the filter build number. | |
| RTSP_Filter_LicenseKey_str | Sets the license key. |