#import <NvsStreamingContext.h>

Inheritance diagram for <NvsStreamingContextDelegate>:

Instance Methods
(void)	- didCaptureDeviceCapsReady:
	The captured device is ready. More...

(void)	- didCaptureDevicePreviewResolutionReady:
	Captured device resolution is ready. More...

(void)	- didCaptureDevicePreviewStarted:
	Startes the captured device preview. More...

(void)	- didCaptureDeviceError:errorCode:
	Capture device error. More...

(void)	- didCaptureDeviceStopped:
	Stopps the captured device. More...

(void)	- didCaptureDeviceAutoFocusComplete:succeeded:
	The captured device's autofocus is completed. More...

(void)	- didCaptureRecordingStarted:
	Recording started. More...

(void)	- didCaptureRecordingFirstVideoFrameReached:timeStamp:
	Recording first video frame is presented.. More...

(void)	- didCaptureRecordingDurationUpdated:duration:
	Notification of recording's duration. More...

(void)	- didCaptureRecordingFinished:
	Recording is completed. More...

(void)	- didCaptureRecordingError:
	Recording fails. More...

(void)	- didPlaybackPreloadingCompletion:
	Playback preload completed. More...

(void)	- didPlaybackTimelinePosition:position:
	Current position of timeline playback. More...

(void)	- didPlaybackDelayed:delayTime:isVideo:
	Timeline playback delay. More...

(void)	- didPlaybackStopped:
	Playback stopped. More...

(void)	- didPlaybackEOF:
	Playbacks to the end. More...

(void)	- didCompileProgress:progress:
	Progress of compiling video file. More...

(void)	- didCompileFloatProgress:progress:
	Progress of compiling video file. More...

(void)	- didCompileFinished:
	Compiling video file is completed. More...

(void)	- didCompileCompleted:isCanceled:
	Compiling video file is completed. More...

(void)	- didCompileCompleted:isHardwareEncoding:errorType:errorString:flags:
	Timeline compile file completion. More...

(void)	- didCompileFailed:
	Fails to compile video file. More...

(void)	- didCompileSliceCompleted:filePath:isVideo:index:
	Timeline compile slice file completion. More...

(void)	- didStreamingEngineStateChanged:
	Engine state changed. More...

(void)	- didFirstVideoFramePresented:
	First video frame is presented. More...

(void)	- didTimestampOutOfRange:
	Timeline out of bounds (Note: Do not use this callback interface if it is not necessary). More...

(void)	- didSeekingTimelinePosition:position:
	Current position of seeking the timeline. More...

(void)	- captureVideoFrameGrabbedArrived:
	Gets the captured video frame. More...

(void)	- onAudioSampleArrived:
	Get audio sample data from capture device.This interface triggers callbacks when recording. More...

(void)	- capturePreviewAudioSampleArrived:
	Get audio sample data from capture device.This interface can fetch the audio callback while capturing the preview. More...

(void)	- capturePictureArrived:
	Gets the captured video frame. More...

(void)	- onPlaybackException:exceptionType:exceptionString:
	Exception in timeline playback. More...

(void)	- onHardwareError:stringInfo:
	Hardware error information. Deprecated, use onMediaError instead. More...

(void)	- onMediaError:
	Media error information. More...

(void)	- didVUMeterValue:leftValue:rightValue:timestamp:
	Get DB value from timeline. More...

(void)	- onAudioSampleArrived:audioSample:
	Get audio sample data from timeline. More...

Method Documentation

◆ capturePictureArrived:

- (void) capturePictureArrived: (NvsVideoFrameInfo *) sampleBufferInfo

optional

Gets the captured video frame.

Please pay attention: this function is called in a separate thread, not in the UI thread. Please consider thread-safe issues!!

Parameters

sampleBufferInfo The obtained image data

Since: 1.4.0

◆ capturePreviewAudioSampleArrived:

- (void) capturePreviewAudioSampleArrived: (NvsAudioSampleBuffers *) audioSample

optional

Get audio sample data from capture device.This interface can fetch the audio callback while capturing the preview.

Parameters

audioSample Captured audio sample data.

Since: 3.11.0

◆ captureVideoFrameGrabbedArrived:

- (void) captureVideoFrameGrabbedArrived: (NvsVideoFrameInfo *) sampleBufferInfo

optional

Gets the captured video frame.

Please pay attention: this function is called in a separate thread, not in the UI thread. Please consider thread-safe issues!!

Parameters

sampleBufferInfo The obtained image data

Since: 1.4.0

◆ didCaptureDeviceAutoFocusComplete:succeeded:

- (void) didCaptureDeviceAutoFocusComplete:	(unsigned int)	captureDeviceIndex
succeeded:	(BOOL)	succeeded

optional

The captured device's autofocus is completed.

Parameters

captureDeviceIndex	Device index
succeeded	Whether the autofocus is completed.

◆ didCaptureDeviceCapsReady:

- (void) didCaptureDeviceCapsReady: (unsigned int) captureDeviceIndex

optional

The captured device is ready.

Parameters

captureDeviceIndex Device index

◆ didCaptureDeviceError:errorCode:

- (void) didCaptureDeviceError:	(unsigned int)	captureDeviceIndex
errorCode:	(int32_t)	errorCode

optional

Capture device error.

Parameters

captureDeviceIndex	Device index
errorCode	Error code, please refert to CAPTURE_DEVICE_ERROR_CODE

◆ didCaptureDevicePreviewResolutionReady:

- (void) didCaptureDevicePreviewResolutionReady: (unsigned int) captureDeviceIndex

optional

Captured device resolution is ready.

Parameters

captureDeviceIndex Device index

◆ didCaptureDevicePreviewStarted:

- (void) didCaptureDevicePreviewStarted: (unsigned int) captureDeviceIndex

optional

Startes the captured device preview.

Parameters

captureDeviceIndex Device index

◆ didCaptureDeviceStopped:

- (void) didCaptureDeviceStopped: (unsigned int) captureDeviceIndex

optional

Stopps the captured device.

Parameters

captureDeviceIndex Device index

◆ didCaptureRecordingDurationUpdated:duration:

- (void) didCaptureRecordingDurationUpdated:	(int)	captureDeviceIndex
duration:	(int64_t)	duration

optional

Notification of recording's duration.

Parameters

captureDeviceIndex	Device index
duration	The duration that has been recorded (in microseconds).

Since: 1.17.0

◆ didCaptureRecordingError:

- (void) didCaptureRecordingError: (unsigned int) captureDeviceIndex

optional

Recording fails.

Parameters

captureDeviceIndex Device index

See also: - didCaptureRecordingStarted:; - didCaptureRecordingFinished:

◆ didCaptureRecordingFinished:

- (void) didCaptureRecordingFinished: (unsigned int) captureDeviceIndex

optional

Recording is completed.

Parameters

captureDeviceIndex Device index

See also: - didCaptureRecordingStarted:; - didCaptureRecordingError:

◆ didCaptureRecordingFirstVideoFrameReached:timeStamp:

- (void) didCaptureRecordingFirstVideoFrameReached:	(unsigned int)	captureDeviceIndex
timeStamp:	(int64_t)	timestamp

optional

Recording first video frame is presented..

Parameters

captureDeviceIndex	Device index
timeStamp	First video frame timestamp

See also: - didCaptureRecordingFinished:; - didCaptureRecordingError:

Since: 2.14.0

◆ didCaptureRecordingStarted:

- (void) didCaptureRecordingStarted: (unsigned int) captureDeviceIndex

optional

Recording started.

Parameters

captureDeviceIndex Device index

See also: - didCaptureRecordingFinished:; - didCaptureRecordingError:

Since: 1.16.0

◆ didCompileCompleted:isCanceled:

- (void) didCompileCompleted:	(NvsTimeline *)	timeline
isCanceled:	(BOOL)	isCanceled

optional

Compiling video file is completed.

Parameters

timeline	Timeline
isCanceled	The midway cancellation results in the completion of the compile. Note: any operations on the engine that causes compilation to stop are refer to as cancelation.

Since: 1.6.0

See also: - didCompileFinished:

◆ didCompileCompleted:isHardwareEncoding:errorType:errorString:flags:

- (void) didCompileCompleted:	(NvsTimeline *)	timeline
isHardwareEncoding:	(BOOL)	isHardwareEncoding
errorType:	(int)	errorType
errorString:	(NSString *)	errorString
flags:	(int)	flags

optional

Timeline compile file completion.

Parameters

timeline	Timeline.
isHardwareEncoder	Whether hardware coding is used for completion.
errorType	Type of compile error, please refert to COMPILE_ERROR_TYPE
stringInfo	Assistance information.
flags	flags

Since: 2.22.0

◆ didCompileFailed:

- (void) didCompileFailed: (NvsTimeline *) timeline

optional

Fails to compile video file.

Parameters

timeline Timeline

◆ didCompileFinished:

- (void) didCompileFinished: (NvsTimeline *) timeline

optional

Compiling video file is completed.

Parameters

timeline Timeline

See also: - didCompileFailed:

◆ didCompileFloatProgress:progress:

- (void) didCompileFloatProgress:	(NvsTimeline *)	timeline
progress:	(float)	progress

optional

Progress of compiling video file.

Parameters

timeline	Timeline
progress	float Progress

◆ didCompileProgress:progress:

- (void) didCompileProgress:	(NvsTimeline *)	timeline
progress:	(int)	progress

optional

Progress of compiling video file.

Parameters

timeline	Timeline
progress	Progress

◆ didCompileSliceCompleted:filePath:isVideo:index:

- (void) didCompileSliceCompleted:	(NvsTimeline *)	timeline
filePath:	(NSString *)	filePath
isVideo:	(BOOL)	isVideo
index:	(int)	index

optional

Timeline compile slice file completion.

Parameters

timeline	Timeline.
filePath	Media file path
isVideo	Whether is video or audio
index	Media index

Since: 3.13.0

◆ didFirstVideoFramePresented:

- (void) didFirstVideoFramePresented: (NvsTimeline *) timeline

optional

First video frame is presented.

Parameters

timeline Timeline

◆ didPlaybackDelayed:delayTime:isVideo:

- (void) didPlaybackDelayed:	(NvsTimeline *)	timeline
delayTime:	(int64_t)	time
isVideo:	(bool)	flag

optional

Timeline playback delay.

Parameters

timeline	Timeline
time	Delay time
flag	Whether it's video (true is video, false is audio).

Since: 2.5.0

◆ didPlaybackEOF:

- (void) didPlaybackEOF: (NvsTimeline *) timeline

optional

Playbacks to the end.

Parameters

timeline Timeline

◆ didPlaybackPreloadingCompletion:

- (void) didPlaybackPreloadingCompletion: (NvsTimeline *) timeline

optional

Playback preload completed.

Parameters

timeline Timeline

◆ didPlaybackStopped:

- (void) didPlaybackStopped: (NvsTimeline *) timeline

optional

Playback stopped.

Parameters

timeline Timeline

◆ didPlaybackTimelinePosition:position:

- (void) didPlaybackTimelinePosition:	(NvsTimeline *)	timeline
position:	(int64_t)	position

optional

Current position of timeline playback.

Parameters

timeline	Timeline
position	Current position

Since: 1.6.0

◆ didSeekingTimelinePosition:position:

- (void) didSeekingTimelinePosition:	(NvsTimeline *)	timeline
position:	(int64_t)	position

optional

Current position of seeking the timeline.

Parameters

timeline	Timeline
position	Current position

Since: 2.5.0

◆ didStreamingEngineStateChanged:

- (void) didStreamingEngineStateChanged: (NvsStreamingEngineState) state

optional

Engine state changed.

Parameters

state Engine state

◆ didTimestampOutOfRange:

- (void) didTimestampOutOfRange: (NvsTimeline *) timeline

optional

Timeline out of bounds (Note: Do not use this callback interface if it is not necessary).

Parameters

timeline Timeline

Since: 1.2.0

◆ didVUMeterValue:leftValue:rightValue:timestamp:

- (void) didVUMeterValue:	(NvsTimeline *)	timeline
leftValue:	(float)	left
rightValue:	(float)	right
timestamp:	(int64_t)	time

optional

Get DB value from timeline.

Parameters

timeline	Timeline.
leftVUValue	Audio output left channel DB value.
rightVUValue	Audio output right channel DB value.

◆ onAudioSampleArrived:

- (void) onAudioSampleArrived: (NvsAudioSampleBuffers *) audioSample

optional

Get audio sample data from capture device.This interface triggers callbacks when recording.

Parameters

audioSample Captured audio sample data.

Since: 3.0.3

◆ onAudioSampleArrived:audioSample:

- (void) onAudioSampleArrived:	(NvsTimeline *)	timeline
audioSample:	(NvsAudioSampleBuffers *)	audioSample

optional

Get audio sample data from timeline.

Parameters

timeline	Timeline.
audioSample	Audio output sample data.

◆ onHardwareError:stringInfo:

- (void) onHardwareError:	(NvsStreamingEngineHarwareErrorType)	errorType
stringInfo:	(NSString *)	stringInfo

optional

Hardware error information. Deprecated, use onMediaError instead.

Parameters

errorType	Type of hardware error, please refert to NvsStreamingEngineHarwareErrorType
stringInfo	Assistance information.

Deprecated:

Since: 1.16.0

◆ onMediaError:

- (void) onMediaError: (NvsMediaError *) error

optional

Media error information.

Parameters

error	error info
stringInfo	Assistance information.

Since: 3.14.0

◆ onPlaybackException:exceptionType:exceptionString:

- (void) onPlaybackException:	(NvsTimeline *)	timeline
exceptionType:	(NvsStreamingEnginePlaybackExceptionType)	exceptionType
exceptionString:	(NSString *)	exceptionString

optional

Exception in timeline playback.

Parameters

timeline	Timeline.
exceptionType	Exception type，please refert to STREAMING_ENGINE_PLAYBACK_EXCEPTION_TYPE
exceptionString	Exception information

Since: 3.0.0

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

include/sdkcore/ios/NvsStreamingContext.h

Instance Methods

Method Documentation

◆ capturePictureArrived:

◆ capturePreviewAudioSampleArrived:

◆ captureVideoFrameGrabbedArrived:

◆ didCaptureDeviceAutoFocusComplete:succeeded:

◆ didCaptureDeviceCapsReady:

◆ didCaptureDeviceError:errorCode:

◆ didCaptureDevicePreviewResolutionReady:

◆ didCaptureDevicePreviewStarted:

◆ didCaptureDeviceStopped:

◆ didCaptureRecordingDurationUpdated:duration:

◆ didCaptureRecordingError:

◆ didCaptureRecordingFinished:

◆ didCaptureRecordingFirstVideoFrameReached:timeStamp:

◆ didCaptureRecordingStarted:

◆ didCompileCompleted:isCanceled:

◆ didCompileCompleted:isHardwareEncoding:errorType:errorString:flags:

◆ didCompileFailed:

◆ didCompileFinished:

◆ didCompileFloatProgress:progress:

◆ didCompileProgress:progress:

◆ didCompileSliceCompleted:filePath:isVideo:index:

◆ didFirstVideoFramePresented:

◆ didPlaybackDelayed:delayTime:isVideo:

◆ didPlaybackEOF:

◆ didPlaybackPreloadingCompletion:

◆ didPlaybackStopped:

◆ didPlaybackTimelinePosition:position:

◆ didSeekingTimelinePosition:position:

◆ didStreamingEngineStateChanged:

◆ didTimestampOutOfRange:

◆ didVUMeterValue:leftValue:rightValue:timestamp:

◆ onAudioSampleArrived:

◆ onAudioSampleArrived:audioSample:

◆ onHardwareError:stringInfo:

◆ onMediaError:

◆ onPlaybackException:exceptionType:exceptionString: