MediaStreamSourceSampleRequest.ReportSampleProgress(UInt32) Method

Definition

Provides a status update to the MediaStreamSource while the application is temporarily unable to deliver a requested MediaStreamSample.

public:
 virtual void ReportSampleProgress(unsigned int progress) = ReportSampleProgress;
void ReportSampleProgress(uint32_t const& progress);
public void ReportSampleProgress(uint progress);
function reportSampleProgress(progress)
Public Sub ReportSampleProgress (progress As UInteger)

Parameters

progress
UInt32

unsigned int

uint32_t

A value between 0 to 100 that indicates the progress towards being able to deliver the requested MediaStreamSample.

Remarks

The application should invoke this method when it is unable to immediately to deliver the MediaStreamSample, which is accomplished by assigning it to the Sample property. The application should continue to invoke ReportSampleProgress on a regular basis until it is able to deliver the requested MediaStreamSample.

The recommended interval between each invocation of ReportSampleProgress is 500 milliseconds.

Applies to