URtspMediaSource

API > API/Plugins > API/Plugins/RTSPMedia

   
Name URtspMediaSource
Type class
Header File /Engine/Plugins/Media/RTSPMedia/Source/RTSPMedia/Public/RtspMediaSource.h
Include Path #include "RtspMediaSource.h"

Syntax

UCLASS (BlueprintType, HideCategories=(Platforms, Object), Meta=(DisplayName="RTSP Media Source"))  
class URtspMediaSource : public UBaseMediaSource

Inheritance Hierarchy

Implements Interfaces

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAutoReconnect bool Automatically reconnect when the connection fails The player will begin reconnection attempts after the delay specified in Min Retry Delay RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Client"
bJitterBufferAutoAdjust bool The jitter buffer accounts for spikes in the network delivery of RTP packets in order to provide a steady stream of packets to the decoder. RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Jitter Buffer"
  • Meta=(DisplayName="Auto Adjust")
bProvideCpuBuffer bool Populate a CPU-accessible pixel buffer alongside the GPU texture Whether this is available depends on the underlying decoder implementation RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Decoder"
  • Meta=(DisplayName="Provide CPU Buffer")
DecoderBufferSize int32 Decoder reorder buffer size. RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Decoder"
  • Meta=(DisplayName="Buffer Size (frames)", ClampMin="1", ClampMax="16")
DecoderPollIntervalMs int32 How frequently to poll the decoder for output frames (in milliseconds) Lower values reduce latency but increase CPU usage RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Decoder"
  • Meta=(DisplayName="Poll Interval (ms)", ClampMin="1", ClampMax="10")
Host FString Host name or IP address of the RTSP server RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Server"
JitterBufferDepthMs int32 A higher buffer depth will absorb more network jitter at the cost of additional latency. RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Jitter Buffer"
  • Meta=(DisplayName="Depth (ms)", EditCondition="!bJitterBufferAutoAdjust", EditConditionHides, ClampMin="0", ClampMax="5000")
JitterBufferObservationWindowSeconds float How long network conditions must remain stable before the jitter buffer depth is reduced. RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Jitter Buffer"
  • Meta=(DisplayName="Observation Window (s)", EditCondition="bJitterBufferAutoAdjust", EditConditionHides, ClampMin="30.0", ClampMax="300.0")
MaxFragmentBufferSizeMb int32 Places a limit on how much memory is used for fragmented NAL unit reassembly NAL units will be dropped if this memory limit is exceeded Consider increasing this value for high bitrate streams RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Depacketization"
  • Meta=(DisplayName="Max Fragment Buffer Size (MB)", ClampMin="2", ClampMax="64")
MaxQueuedVideoSamples int32 Maximum decoded video frames to queue while waiting for game thread consumption Higher values reduce visible skips after game thread hitches at the cost of memory RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Decoder"
  • Meta=(ClampMin="2", ClampMax="16")
MaxReconnectAttempts int32 The maximum number of times the player will attempt to reconnect after a connection failure Set to 0 to retry indefinitely RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Client"
  • Meta=(EditCondition="bAutoReconnect", ClampMin="0", ClampMax="1000")
MaxReconnectDelaySeconds float The maximum amount of time to wait before attempting to reconnect after a connection failure The player will gradually increase the delay before each connection attempt but for no longer than this maximum RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Client"
  • Meta=(DisplayName="Max Reconnect Delay (s)", EditCondition="bAutoReconnect", ClampMin="1.0", ClampMax="300.0")
MinReconnectDelaySeconds float The minimum amount of time to wait before attempting to reconnect after a connection failure RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Client"
  • Meta=(DisplayName="Min Reconnect Delay (s)", EditCondition="bAutoReconnect", ClampMin="1.0", ClampMax="60.0")
Path FString Path to the stream on RTSP server RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Server"
Port int32 Port number of the RTSP Server RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Server"
  • Meta=(ClampMin="1", ClampMax="65535")
RequestTimeoutSeconds float RTSP request timeout in seconds. RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Client"
  • Meta=(DisplayName="Request Timeout (s)", ClampMin="1.0", ClampMax="30.0")
SocketBufferSizeKb int32 Socket buffer size for stream data in KB. Increase this setting for high bitrate streams (e.g. 4K) RtspMediaSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Client"
  • Meta=(DisplayName="Socket Buffer Size (KB)", ClampMin="128", ClampMax="4096")
TransportProtocol ERtspMediaTransportProtocol Only TCP interleaved transport is supported RtspMediaSource.h
  • BlueprintReadOnly
  • Category="Client"
  • Meta=(Hidden)

Functions

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page