MeiCam SDK For Android  3.10.0
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
com.meicam.sdk.NvsStreamingContext Class Reference

Streaming context. More...

Classes

interface  AudioOutputCallback
 Callback interface for audio output. More...
 
interface  CapturedAudioCallback
 Callback interface for captured audio samples. More...
 
interface  CaptureDeviceCallback
 Capture device callback interface. More...
 
class  CaptureDeviceCapability
 Description of capturing device's capabilities. More...
 
interface  CapturedPictureCallback
 Gets callback interface of the captured preview. More...
 
interface  CapturedVideoFrameGrabberCallback
 Gets callback interface of the captured preview video frame. More...
 
interface  CaptureRecordingDurationCallback
 Callback interface for recording duration. More...
 
interface  CaptureRecordingFrameReachedCallback
 Callback interface for first recording frame reached. More...
 
interface  CaptureRecordingStartedCallback
 Callback interface for starting recording. More...
 
interface  CompileCallback
 Callback interface for timeline's compiling file. More...
 
interface  CompileCallback2
 The second callback interface for timeline file compilation. More...
 
interface  CompileCallback3
 The third callback interface for timeline file compilation. More...
 
interface  CompileFloatProgressCallback
 
interface  HardwareErrorCallback
 Hardware error callback interface. More...
 
interface  ImageGrabberCallback
 The callback interface of the grabbed image from timeline. More...
 
interface  ImageGrabberCallback2
 The second callback interface of the grabbed image from timeline. More...
 
class  NvsCapturedAudioSampleInfo
 Audio sample info from capturing. More...
 
interface  PlaybackCallback
 Callback interface for timeline playback. More...
 
interface  PlaybackCallback2
 The second callback interface for timeline playback. More...
 
interface  PlaybackDelayCallback
 Callback interface for playback delay. More...
 
interface  PlaybackExceptionCallback
 Callback interface for timeline playback exception. More...
 
class  SdkVersion
 The version information of Meishe SDK. More...
 
interface  SeekingCallback
 Callback interface for timeline search. More...
 
interface  StreamingEngineCallback
 Callback interface for streaming engine. More...
 
class  templateFootageInfo
 information of template footage More...
 
interface  TimelineTimestampCallback
 Callback interface for timeline timestamp (note: Do not use this interface unless neccessary). More...
 
interface  VideoFrameReceiver
 Hardware error callback interface. More...
 

Public Member Functions

boolean isSdkAuthorised ()
 Checks if sdk is authorized. More...
 
int getGLMaxTextureSize ()
 Get GL max texture size. More...
 
boolean preloadEffectResources ()
 Preload effect resources. More...
 
float detectEngineRenderFramePerSecond ()
 Get engine render fps, only valid after calling StartCapturePreview or PlaybackTimeline. More...
 
SdkVersion getSdkVersion ()
 Obtains Meishe SDK's version information. More...
 
NvsAssetPackageManager getAssetPackageManager ()
 Gets resource package manager. More...
 
void setCaptureDeviceCallback (CaptureDeviceCallback cb)
 Sets callback interface for capturing device. More...
 
void setCapturedVideoFrameGrabberCallback (CapturedVideoFrameGrabberCallback cb)
 Sets callback interface for getting capture preview frame. More...
 
void setCapturedPictureCallback (CapturedPictureCallback cb)
 Sets callback interface for getting capture preview frame. More...
 
void setCaptureRecordingStartedCallback (CaptureRecordingStartedCallback cb)
 Sets callback interface for recording started. More...
 
void setCaptureRecordingFrameReachedCallback (CaptureRecordingFrameReachedCallback cb)
 Sets callback interface for recording frame reached. More...
 
void setCaptureRecordingDurationCallback (CaptureRecordingDurationCallback cb)
 Sets callback interface of recording duration. More...
 
void setPlaybackCallback (PlaybackCallback cb)
 Sets the callback interface for timeline playback. More...
 
void setCompileCallback (CompileCallback cb)
 Sets callback interface for timeline file compilation. More...
 
void setStreamingEngineCallback (StreamingEngineCallback cb)
 Sets callback interface for streaming engine. More...
 
void setTimelineTimestampCallback (TimelineTimestampCallback cb)
 Sets callback interface for timeline timestamp. More...
 
void setCompileCallback2 (CompileCallback2 cb)
 Sets the second callback interface for timeline file compilation. More...
 
void setCompileCallback3 (CompileCallback3 cb)
 Sets the third callback interface for timeline file compilation. More...
 
void setCompileFloatProgressCallback (CompileFloatProgressCallback cb)
 
void setPlaybackCallback2 (PlaybackCallback2 cb)
 Sets second callback interface for timeline playback. More...
 
void setPlaybackDelayCallback (PlaybackDelayCallback cb)
 Sets callback interface for delay playback. More...
 
void setPlaybackExceptionCallback (PlaybackExceptionCallback cb)
 Sets callback interface for playback exception. More...
 
void setSeekingCallback (SeekingCallback cb)
 Sets the timeline search callback interface. More...
 
void setHardwareErrorCallback (HardwareErrorCallback cb)
 Sets callback interface for hardware error. More...
 
void setAudioOutputCallback (AudioOutputCallback cb)
 Sets callback interface of audio output. More...
 
void setCapturedAudioCallback (CapturedAudioCallback cb)
 Sets callback interface of audio output. More...
 
NvsAVFileInfo getAVFileInfo (String avFilePath)
 Gets detailed information of the audio/video file. More...
 
NvsAVFileInfo getAVFileInfo (String avFilePath, int extraFlag)
 Gets detailed information of the audio/video file. More...
 
NvsAVFileInfo getAVFileInfoWithError (String avFilePath, int extraFlag, StringBuilder errorString)
 Gets detailed information of the audio/video file. More...
 
int detectVideoFileKeyframeInterval (String videoFilePath)
 Detects video file's I-Frame interval. More...
 
boolean setDefaultThemeEndingLogoImageFilePath (String logoImageFilePath)
 Sets default theme's ending logo. More...
 
String getDefaultThemeEndingLogoImageFilePath ()
 Gets the file path of the default ending logo. More...
 
String registerFontByFilePath (String fontFilePath)
 Gets font file's fontFamily. More...
 
List< NvsFontInfogetFontInfoByFilePath (String fontFilePath)
 Gets font file's font information. More...
 
boolean setThemeEndingEnabled (boolean enable)
 Sets whether to display theme ending's special effects. More...
 
int getEngineHDRCaps ()
 Get HDR capability. More...
 
NvsTimeline createTimeline (NvsVideoResolution videoEditRes, NvsRational videoFps, NvsAudioResolution audioEditRes)
 Creates timeline. More...
 
NvsTimeline createTimeline (NvsVideoResolution videoEditRes, NvsRational videoFps, NvsAudioResolution audioEditRes, int flags)
 Creates timeline. More...
 
NvsTimeline createTimeline (String templateId, List< templateFootageInfo > templateFootages)
 Creates timeline. More...
 
NvsTimeline createTimeline (String templateId, List< templateFootageInfo > templateFootages, int flags)
 Creates timeline. More...
 
NvsTimeline createTimeline (String templateId, List< templateFootageInfo > templateFootages, int flags, NvsRational videoFps, NvsAudioResolution audioResolution)
 Creates timeline. More...
 
boolean removeTimeline (NvsTimeline timeline)
 Removes timeline. More...
 
boolean exportTemplateInfo (String templateUuid, NvsTimeline timeline, int requestedAspectRatio)
 Export template information. More...
 
boolean generateTemplatePackage (String templateUuid, String innerAssetDir, String templateOutputDir)
 Generate template asset package. More...
 
void setTemplateCustomResourceDir (String templateUuid, String customResourceDir)
 set templates/project custom resource folders More...
 
boolean exportProjectInfo (String projectUuid, NvsTimeline timeline, int requestedAspectRatio)
 Export project information. More...
 
boolean generateProjectPackage (String projectUuid, String innerAssetDir, String projectOutputDir)
 Generate project asset package. More...
 
NvsTimeline loadProject (String projectId, String resourceDir, int flags)
 Load project. More...
 
int getStreamingEngineState ()
 Gets streaming engine's state. More...
 
long getTimelineCurrentPosition (NvsTimeline timeline)
 Gets the current positon of the timeline (in microseconds) More...
 
boolean compileTimeline (NvsTimeline timeline, long startTime, long endTime, String outputFilePath, int videoResolutionGrade, int videoBitrateGrade, int flags)
 Compiles timeline into a file. More...
 
boolean compileTimeline (NvsTimeline timeline, long startTime, long endTime, String outputFilePath, int videoResolutionGrade, int videoBitrateGrade, Hashtable< String, Object > compileConfigurations, int flags)
 Compiles timeline into a file. More...
 
boolean pauseCompiling ()
 Pause compiling timeline. More...
 
boolean resumeCompiling ()
 Resume compiling timeline. More...
 
boolean isCompilingPaused ()
 Check if compiling timeline is paused. More...
 
void setCustomCompileVideoHeight (int videoHeight)
 Sets the customized height for video. More...
 
int getCustomCompileVideoHeight ()
 Gets the customized video height. More...
 
boolean compilePassthroughTimeline (NvsTimeline timeline, String outputFilePath, Hashtable< String, Object > compileConfigurations, int flags)
 Compile passthrough the video clips on video track 0 in the timeline into a file without processing filter, multi track and nested timeline. If there are photos, it will fail. More...
 
boolean connectTimelineWithLiveWindow (NvsTimeline timeline, NvsLiveWindow liveWindow)
 Connects timeline with the LiveWindow. More...
 
boolean connectTimelineWithLiveWindowExt (NvsTimeline timeline, NvsLiveWindowExt liveWindow)
 Connects timeline with the LiveWindow (based on TextureView) More...
 
boolean connectTimelineWithSurfaceTexture (NvsTimeline timeline, SurfaceTexture outputSurfaceTexture)
 Connects timeline with a SurfaceTexture, of which the rendering outcome of the timeline will be output to this SurfaceTexture. More...
 
boolean connectTimelineWithSurfaceTexture (NvsTimeline timeline, SurfaceTexture outputSurfaceTexture, NvsRational proxyScale)
 Connects timeline with SurfaceTexture and set the proxy scale. The timeline's rendering outcome will be output to this SurfaceTexture. More...
 
boolean connectTimelineWithVideoFrameReceiver (NvsTimeline timeline, VideoFrameReceiver receiver, NvsRational proxyScale, int flags)
 Connects timeline with video frame receiver and set the proxy scale. More...
 
boolean seekTimeline (NvsTimeline timeline, long timestamp, int videoSizeMode, int flags)
 Seeking the frame at a specific timestamp. More...
 
boolean seekTimeline (NvsTimeline timeline, long timestamp, NvsRational proxyScale, int flags)
 Seeking the frame at a specific timestamp. More...
 
Bitmap grabImageFromTimeline (NvsTimeline timeline, long timestamp, NvsRational proxyScale)
 Gets the specific frame in timeline with a specific timestamp. For details please refer to The video frame retriever . More...
 
Bitmap grabImageFromTimeline (NvsTimeline timeline, long timestamp, NvsRational proxyScale, int flags)
 Gets the specific frame in timeline with a specific timestamp. For details please refer to The video frame retriever. More...
 
void setImageGrabberCallback (ImageGrabberCallback callback)
 Sets callback interface for timeline image grabber. More...
 
void setImageGrabberCallback2 (ImageGrabberCallback2 callback)
 Sets second callback interface for timeline image grabber. More...
 
boolean grabImageFromTimelineAsync (NvsTimeline timeline, long timestamp, NvsRational proxyScale, int flags)
 Gets the specific frame in timeline with a specific timestamp. For details please refer to The video frame retriever. This function is an internal asynchronous call. It is necessary to ensure that SeekTimeline () will not be invoked before getting the image. If the function that calls SeekTimeline after calling this function may not get the callback of the image, it can call Stop after this function to ensure that the Grab image can be executed successfully. More...
 
boolean playbackTimeline (NvsTimeline timeline, long startTime, long endTime, int videoSizeMode, boolean preload, int flags)
 Timeline playback. More...
 
boolean playbackTimeline (NvsTimeline timeline, long startTime, long endTime, NvsRational proxyScale, boolean preload, int flags)
 Timeline playback. More...
 
boolean pausePlayback ()
 Pause playback timeline. More...
 
boolean resumePlayback ()
 Resume playback timeline. More...
 
boolean isPlaybackPaused ()
 Check if playback timeline is paused. More...
 
void stop ()
 Stops the engine. More...
 
void stop (int flags)
 Stops the engine. More...
 
void clearCachedResources (boolean asynchronous)
 Clears cached resources. More...
 
void clearCachedResources (boolean asynchronous, int flags)
 Clears cached resources. More...
 
int getCaptureDeviceCount ()
 Number of capture device. More...
 
boolean isCaptureDeviceBackFacing (int captureDeviceIndex)
 Whether it's a rear capturing device. More...
 
CaptureDeviceCapability getCaptureDeviceCapability (int captureDeviceIndex)
 Gets the capability description object of the capture device. More...
 
boolean checkDontSetCameraParamOnRecordingWithSystemRecorder ()
 Checks if the camera's parameters cannot be set when recording with system recorder. More...
 
boolean connectCapturePreviewWithLiveWindow (NvsLiveWindow liveWindow)
 Connects the captured preview with live window. More...
 
boolean connectCapturePreviewWithLiveWindowExt (NvsLiveWindowExt liveWindow)
 Connects the captured preview with live windowļ¼ˆbased on TextureViewļ¼‰ More...
 
boolean connectCapturePreviewWithSurfaceTexture (SurfaceTexture outputSurfaceTexture)
 Connects a capture preview with a SurfaceTexture object. The capture preview's rendering result will be output to this SurfaceTexture object. More...
 
void setUserWatermarkForCapture (String watermarkFilePath, int displayWidth, int displayHeight, float opacity, int position, int marginX, int marginY)
 Adds a custom watermark for capturing video. More...
 
void removeUserWatermarkForCapture ()
 Removes custom watermark which added for capturing video. More...
 
boolean startCapturePreview (int captureDeviceIndex, int videoResGrade, int flags, NvsRational aspectRatio)
 Starts the capture preview. More...
 
boolean startCapturePreviewWithSpecialSize (int captureDeviceIndex, int videoResGrade, int flags, NvsSize previewSize)
 Starts the capture preview. More...
 
boolean startBufferCapturePreview (int width, int heidht, NvsRational fps, int rotation, boolean flipHorizontally)
 Starts the capture preview with inputting buffer mode. More...
 
boolean startDualBufferCapturePreview (SurfaceTexture surfaceTexture, int surfaceTextureWidth, int surfaceTextureHeight, int surfaceTextureRotation, int cpuBufferWidth, int cpuBufferHeight, boolean cpuBufferFlipHorizontally, int cpuBufferRotation, NvsRational fps, int flags)
 Starts dual buffer mode for capture preview, one input is from SurfaceTexture and another is from cpu buffer. Two input must be of the same size when rotated to positive direction. More...
 
boolean sendBufferToCapturePreview (byte[] data, long streamTime)
 Transfers the input buffer to capture preivew. More...
 
boolean sendBufferToCapturePreview (byte[] data, long streamTime, int flags)
 Sends buffer to the capture preview. More...
 
NvsSize getCapturePreviewVideoSize (int captureDeviceIndex)
 Gets the capture preview resolution. More...
 
NvsColor sampleColorFromCapturedVideoFrame (RectF sampleRect)
 Samples the capture device's video frame. More...
 
void startAutoFocus (RectF focusRect)
 Starts autofocus. More...
 
void cancelAutoFocus ()
 Cancels the ongoing autofocus. More...
 
void StartContinuousFocus ()
 Starts continuous focus. More...
 
void setAutoExposureRect (RectF exposureRect)
 Set the auto exposure detection area. More...
 
void setZoom (int zoom)
 Sets the zoom value. More...
 
int getZoom ()
 Gets the zoom factor. More...
 
void toggleFlash (boolean flashOn)
 Sets which the flash light is on/off. More...
 
boolean isFlashOn ()
 get state of the flash light. More...
 
int getVideoStabilization ()
 Gets the current videoā€™s stabilization flag. More...
 
void setVideoStabilization (int flags)
 Sets video stabilization. More...
 
void setExposureCompensation (int exposureCompensation)
 Set exposure compensation. More...
 
int getExposureCompensation ()
 Gets exposure compensation. More...
 
NvsCaptureVideoFx appendBuiltinCaptureVideoFx (String videoFxName)
 Appends a built-in capture video effect. More...
 
NvsCaptureVideoFx insertBuiltinCaptureVideoFx (String videoFxName, int insertPosition)
 Inserts a built-in video capture effect. More...
 
NvsCaptureVideoFx appendPackagedCaptureVideoFx (String videoFxPackageId)
 Appends a package capture effectx. More...
 
NvsCaptureVideoFx insertPackagedCaptureVideoFx (String videoFxPackageId, int insertPosition)
 Inserts a package capture effect. More...
 
NvsCaptureVideoFx appendCustomCaptureVideoFx (NvsCustomVideoFx.Renderer customVideoFxRender)
 Appends a custom capture video effect. More...
 
NvsCaptureVideoFx insertCustomCaptureVideoFx (NvsCustomVideoFx.Renderer customVideoFxRender, int insertPosition)
 Inserts a custom capture video effect. More...
 
NvsCaptureVideoFx appendBeautyCaptureVideoFx ()
 Appends a beauty effect. More...
 
NvsCaptureVideoFx insertBeautyCaptureVideoFx (int insertPosition)
 Inserts a skin beauty video effect. More...
 
boolean removeCaptureVideoFx (int captureVideoFxIndex)
 Removes a certain capture video effect indicated by its index. More...
 
void removeAllCaptureVideoFx ()
 Removes all capture video effects. More...
 
int getCaptureVideoFxCount ()
 Gets the count of video effects. More...
 
NvsCaptureVideoFx getCaptureVideoFxByIndex (int captureVideoFxIndex)
 Gets a certain capture video effect. More...
 
NvsCaptureAudioFx appendBuiltinCaptureAudioFx (String audioFxName)
 Appends a built-in capture audio effect. More...
 
NvsCaptureAudioFx insertBuiltinCaptureAudioFx (String audioFxName, int insertPosition)
 Inserts a built-in audio capture effect. More...
 
boolean removeCaptureAudioFx (int captureAudioFxIndex)
 Removes a certain capture audio effect indicated by its index. More...
 
void removeAllCaptureAudioFx ()
 Removes all capture audio effects. More...
 
int getCaptureAudioFxCount ()
 Gets the count of audio effects. More...
 
NvsCaptureAudioFx getCaptureAudioFxByIndex (int captureAudioFxIndex)
 Gets a certain capture audio effect. More...
 
NvsCaptureAnimatedSticker appendCaptureAnimatedSticker (long offsetTime, long duration, String animatedStickerPackageId)
 Appends a animated sticker. More...
 
NvsCaptureAnimatedSticker insertCaptureAnimatedSticker (long offsetTime, long duration, String animatedStickerPackageId, int insertPosition)
 Appends a animated sticker. More...
 
NvsCaptureAnimatedSticker addCustomCaptureAnimatedSticker (long inPoint, long duration, String animatedStickerPackageId, String customImagePath)
 Add a custom animated sticker on capture. More...
 
NvsCaptureAnimatedSticker insertCustomCaptureAnimatedSticker (long offsetTime, long duration, String animatedStickerPackageId, String customImagePath, int insertPosition)
 Insert a animated sticker. More...
 
boolean removeCaptureAnimatedSticker (int captureAnimagedStickerIndex)
 Removes a certain capture animated sticker indicated by its index. More...
 
void removeAllCaptureAnimatedSticker ()
 Removes all capture animated sticker. More...
 
int getCaptureAnimatedStickerCount ()
 Gets the count of capture animated sticker. More...
 
NvsCaptureAnimatedSticker getCaptureAnimatedStickerByIndex (int captureStikcerIndex)
 Gets a certain capture animated sticker. More...
 
NvsCaptureCompoundCaption appendCaptureCompoundCaption (long offsetTime, long duration, String compoundCaptionPackageId)
 Appends a compound caption. More...
 
NvsCaptureCompoundCaption insertCaptureCompoundCaption (long offsetTime, long duration, String compoundCaptionPackageId, int insertPosition)
 Insert a compound caption. More...
 
boolean removeCaptureCompoundCaption (int captureCompoundCaptionIndex)
 Removes a certain capture compound caption indicated by its index. More...
 
void removeAllCaptureCompoundCaption ()
 Removes all capture compound caption. More...
 
int getCaptureCompoundCaptionCount ()
 Gets the count of capture compound caption. More...
 
NvsCaptureCompoundCaption getCaptureCompoundCaptionByIndex (int captureCaptionIndex)
 Gets a certain capture compound caption. More...
 
NvsCaptureCaption appendCaptureCaption (String captionText, long offsetTime, long duration, String captionStylePackageId)
 Appends a caption. More...
 
NvsCaptureCaption insertCaptureCaption (String captionText, long offsetTime, long duration, String captionStylePackageId, int insertPosition)
 Insert a caption. More...
 
NvsCaptureCaption appendCaptureModularCaption (String captionText, long offsetTime, long duration)
 Appends a modular caption. More...
 
NvsCaptureCaption insertCaptureModularCaption (String captionText, long offsetTime, long duration, int insertPosition)
 Insert a modular caption. More...
 
boolean removeCaptureCaption (int captureCaptionIndex)
 Removes a certain capture caption indicated by its index. More...
 
void removeAllCaptureCaption ()
 Removes all capture caption. More...
 
int getCaptureCaptionCount ()
 Gets the count of capture caption. More...
 
NvsCaptureCaption getCaptureCaptionByIndex (int captureCaptionIndex)
 Gets a certain capture caption. More...
 
boolean applyCaptureScene (String captureSceneId)
 Apply a capture scene resource package to the capture device. More...
 
boolean applyCaptureScene (String captureSceneId, NvsCaptureSceneInfo info)
 Apply a capture scene resource package to the capture device. More...
 
String getCurrentCaptureSceneId ()
 Gets the ID of the current capture scene resource package. More...
 
void removeCurrentCaptureScene ()
 Removes the current capture scene. More...
 
void setCompileConfigurations (Hashtable< String, Object > compileConfigurations)
 Sets the timeline configurations, which stay valid once set. More...
 
Hashtable< String, Object > getCompileConfigurations ()
 Gets configurations for compiling timeline. More...
 
void setCompileVideoBitrateMultiplier (float compileVideoBitrateMultiplier)
 Set the rate multiplier for compiling video. More...
 
float getCompileVideoBitrateMultiplier ()
 Get the rate multiplier for compiling video. More...
 
void setRecordVideoBitrateMultiplier (float recordVideoBitrateMultiplier)
 Set the rate multiplier for recording video. More...
 
float getRecordVideoBitrateMultiplier ()
 Get the rate multiplier for recording video. More...
 
boolean startRecording (String outputFilePath)
 Starts recording. Please refer to Method of Recording Video. More...
 
boolean startRecording (String outputFilePath, int flags)
 Starts recording. Please refer to Method of Recording Video. More...
 
boolean startRecording (String outputFilePath, int flags, Hashtable< String, Object > recordConfigurations)
 Starts recording. Please refer to Method of Recording Video. More...
 
void stopRecording ()
 Stops recording. More...
 
void stopRecording (boolean synchronous)
 Stops recording. More...
 
void setAudioSampleInfoForCallback (NvsCapturedAudioSampleInfo info)
 Set audio sample information for callback of capturing. More...
 
boolean pauseRecording ()
 Pause to record. Resuming recording after a pause will output the recorded video to the same file. Note: Recording can only be paused without using the built-in recorder! More...
 
boolean resumeRecording ()
 Continues to record. Continuing recording will output the recorded video to the same media file, to which the recording before suspend outputs contents. More...
 
boolean isRecordingPaused ()
 Checks if the recording has been paused. More...
 
boolean takePicture (int flags)
 take a picture with the max resolution of camera which matches the preview resolution best More...
 
void toggleFlashMode (int mode)
 Sets the flash mode. More...
 
int getFlashMode ()
 get state of the flash light. More...
 
List< String > getAllBuiltinVideoFxNames ()
 Gets the list of all built-in video effect names. More...
 
List< String > getAllBuiltinAudioFxNames ()
 Gets the list of all built-in audio effect names. More...
 
List< String > getAllBuiltinCaptureAudioFxNames ()
 Gets the list of all built-in capture audio effect names. More...
 
List< String > getAllBuiltinVideoTransitionNames ()
 Gets the list of all built-in video transitionsā€™ names. More...
 
List< String > getAllBuiltinCaptureVideoFxNames ()
 Gets the list of all built-in capture video effectsā€™ names. More...
 
String getBeautyVideoFxName ()
 Gets the name of beauty effect. More...
 
String getDefaultVideoTransitionName ()
 Gets the default video transitionā€™s name. More...
 
void setDefaultAudioTransitionName (String audioTransitionName)
 Sets the default audio transitionā€™s name. More...
 
NvsFxDescription getVideoFxDescription (String fxName)
 Gets the description of a video effect. More...
 
NvsFxDescription getAudioFxDescription (String fxName)
 Gets the description of an audio effect. More...
 
NvsVideoFrameRetriever createVideoFrameRetriever (String videoFilePath)
 Creates an object of video frame retriever. More...
 
void setDefaultCaptionFade (boolean fade)
 Sets whether default caption mode is fade in and fade out. More...
 
boolean isDefaultCaptionFade ()
 gets whether default caption mode is fade in and fade out. More...
 
void setColorGainForSDRToHDR (float gain)
 Sets the color gain during SDR to HDR conversion. More...
 
float getColorGainForSDRToHDR ()
 gets the color gain during SDR to HDR conversion. More...
 
long calcDurationAfterCurvesVariableSpeed (String curvesString)
 calc the duration after use curves variable speed.noteļ¼š the origin duration is the curves's last endpoint.x-first endpoint.x More...
 
void setAudioOutputDeviceVolume (float volume)
 set volume to audio output device. More...
 
NvsStreamingContext createAuxiliaryStreamingContext (int flags)
 Creates an object of auxiliary streaming context. More...
 
void destoryAuxiliaryStreamingContext (NvsStreamingContext auxContext)
 destory auxiliary streaming context. More...
 
boolean isBlackFrame (Bitmap bitmap)
 Determining whether the incoming bitmap is a black image, and judging by the mean value and variance of the image pixels. More...
 
void SetDefaultImageClipDuration (long defaultImageClipDuration)
 Sets the default image clip duration. More...
 
boolean isAndroidCameraPreferDualBufferAR ()
 Get Android camera device tend to use dual buffer model to render AR. More...
 
int getDeviceGpuLevel ()
 Get Android camera device gpu power level. More...
 
int getDeviceCpuLevel ()
 Get Android camera device cpu power level. More...
 

Static Public Member Functions

static NvsStreamingContext init (Context ctx, String sdkLicenseFilePath, int flags)
 Initializes streaming context instance. More...
 
static NvsStreamingContext init (Activity mainActivity, String sdkLicenseFilePath, int flags)
 Initializes the instance of streaming context object. for more please refer to (4k video editing). More...
 
static NvsStreamingContext init (Activity mainActivity, String sdkLicenseFilePath)
 Initializes an instance of streaming context object. More...
 
static void close ()
 Destroys the streaming context object instance. note: it can be created again after destruction. More...
 
static NvsStreamingContext getInstance ()
 Gets the instance of streaming context object (only can use this after initialization) More...
 
static void openMainThreadChecker (boolean enable)
 Open main thread checker or not. More...
 
static boolean initHumanDetection (Context ctx, String modelFilePath, String licenseFilePath, int features)
 Initializes human detection. Only once needed. More...
 
static boolean initHumanDetectionExt (Context ctx, String modelFilePath, String licenseFilePath, int features)
 Human detection initialization extension. Must be called after calling initHumanDetection. More...
 
static boolean setupHumanDetectionData (int dataType, String dataFilePath)
 Initializes human detection data pack. More...
 
static void closeHumanDetection ()
 Turns off the human detection mechanism. More...
 
static int hasARModule ()
 Checks if current SDK has an AR module. More...
 
static NvsAVFileInfo getAVInfoFromFile (String avFilePath, int extraFlag)
 Gets detailed information of the audio/video file. More...
 

Static Public Attributes

Streaming context flags

static final int STREAMING_CONTEXT_FLAG_SUPPORT_4K_EDIT = 1
 Supports 4K video editting. More...
 
static final int STREAMING_CONTEXT_FLAG_COMPACT_MEMORY_MODE = 2
 Minimizes the memory occupation. More...
 
static final int STREAMING_CONTEXT_FLAG_SUPPORT_8K_EDIT = 4
 Supports 8K edittingting(only for pictures) More...
 
static final int STREAMING_CONTEXT_FLAG_NO_HARDWARE_VIDEO_READER = 8
 Disable hardware decoding. More...
 
static final int STREAMING_CONTEXT_FLAG_ASYNC_ENGINE_STATE = 16
 Switches engine states asynchronously to reduce main thread's jam. More...
 
static final int STREAMING_CONTEXT_VIDEO_DECODER_WITHOUT_SURFACE_TEXTURE = 32
 Decoding not using the SurfaceTexture. More...
 
static final int STREAMING_CONTEXT_FLAG_ASYNC_INITIALIZED = 64
 Streaming Context is initialized asynchronously. More...
 
static final int STREAMING_CONTEXT_FLAG_SUPPORT_16K_EDIT = 128
 Supports 16K editting(only for pictures) More...
 
static final int STREAMING_CONTEXT_FLAG_USE_SYSTEM_IMAGE_READER = 512
 Use system image reader. More...
 
static final int STREAMING_CONTEXT_FLAG_ENABLE_MAX_CACHE_CAPTION_LIMIT = 1024
 Enable max cache cont limit of caption. More...
 
static final int STREAMING_CONTEXT_FLAG_DISABLE_CAPTURE = 2048
 Disable capture. More...
 
static final int STREAMING_CONTEXT_FLAG_PLAYBACK_DROP_FRAME_MODE = 4096
 Drop frame mode in playback timeline (abandon) More...
 
static final int STREAMING_CONTEXT_FLAG_NEED_GIF_MOTION = 8192
 GIF file use motion mode. More...
 
static final int STREAMING_CONTEXT_FLAG_ENABLE_HDR_DISPLAY_WHEN_SUPPORTED = 65536
 Turn on HDR display mode, if the device supports. More...
 
static final int STREAMING_CONTEXT_FLAG_INTERRUPT_STOP_FOR_INTERNAL_STOP = 262144
 Interrupt stop is used for all internal stop, such as stop between seek state and playback state. More...
 
static final int STREAMING_CONTEXT_FLAG_USE_FIXED_DEFAULT_CAPTION_CONTEXT_RESOLUTION = 4194304
 Create default caption context with 1280 * 720 resolution. More...
 
static final int STREAMING_CONTEXT_FLAG_DISABLE_ANDROID_CAMERA2 = 8388608
 Disable camera2 used. More...
 
Clear cache flags

static final int CLEAR_CACHE_FLAG_STREAMING_ENGINE = 1
 Cache of streaming engine. More...
 
static final int CLEAR_CACHE_FLAG_ICON_ENGINE = 2
 Cache of icon engine. More...
 
static final int CLEAR_CACHE_FLAG_WAVEFORM_ENGINE = 4
 Cache of waveform engine. More...
 
static final int CLEAR_CACHE_FLAG_AVFILE_INFO = 8
 Cache of avfile infors. More...
 
static final int CLEAR_CACHE_FLAG_AVFILE_KEYFRAME_INFO = 16
 Cache of video's key frame infos. More...
 
static final int CLEAR_CACHE_FLAG_CAPTION_FONT_INFO = 32
 Cache of font infos. More...
 
Video frame receiver flags

static final int VIDEO_FRAME_RECEIVER_FLAG_FORCE_RGBA_FORMAT = 1
 Force RGBA pixel format on output buffer. More...
 
Streaming engine states

static final int STREAMING_ENGINE_STATE_STOPPED = 0
 Engine stopped. More...
 
static final int STREAMING_ENGINE_STATE_CAPTUREPREVIEW = 1
 Capture preview. More...
 
static final int STREAMING_ENGINE_STATE_CAPTURERECORDING = 2
 Capture recording. More...
 
static final int STREAMING_ENGINE_STATE_PLAYBACK = 3
 Playback. More...
 
static final int STREAMING_ENGINE_STATE_SEEKING = 4
 Seeking. More...
 
static final int STREAMING_ENGINE_STATE_COMPILE = 5
 Compiling file. More...
 
Video capture resolution level

static final int VIDEO_CAPTURE_RESOLUTION_GRADE_LOW = 0
 Low resolution for video capture. More...
 
static final int VIDEO_CAPTURE_RESOLUTION_GRADE_MEDIUM = 1
 Medium resolution for video capture. More...
 
static final int VIDEO_CAPTURE_RESOLUTION_GRADE_HIGH = 2
 High resolution for video capture. More...
 
static final int VIDEO_CAPTURE_RESOLUTION_GRADE_SUPER_HIGH = 3
 Super high resolution for video capture. More...
 
static final int VIDEO_CAPTURE_RESOLUTION_GRADE_EXTREMELY_HIGH = 4
 Extremely high resolution for video capture. More...
 
Video compile resolution level

static final int COMPILE_VIDEO_RESOLUTION_GRADE_360 = 0
 Compiles the video with height 360(the width of video is determined by height and the selected width when creating timeline, caculated by resolution ratio) More...
 
static final int COMPILE_VIDEO_RESOLUTION_GRADE_480 = 1
 Compiles the video with height 480. More...
 
static final int COMPILE_VIDEO_RESOLUTION_GRADE_720 = 2
 Compiles the video with height 720. More...
 
static final int COMPILE_VIDEO_RESOLUTION_GRADE_1080 = 3
 Compiles the video with height 1080. More...
 
static final int COMPILE_VIDEO_RESOLUTION_GRADE_2160 = 4
 Compiles the video with height 2160. More...
 
static final int COMPILE_VIDEO_RESOLUTION_GRADE_CUSTOM = 256
 Customizes the height of video compiledļ¼Œmust be used with the API named setCustomCompileVideoHeight. More...
 
The bitrate of video compiled

static final int COMPILE_BITRATE_GRADE_LOW = 0
 Low bitrate for video compiled. More...
 
static final int COMPILE_BITRATE_GRADE_MEDIUM = 1
 Medium bitrate for video compiled. More...
 
static final int COMPILE_BITRATE_GRADE_HIGH = 2
 High bitrate for video compiled. More...
 
The encode profile of video compiled

static final int COMPILE_ENCODE_PROFILE_BASELINE = 1
 base line profile for video encode More...
 
static final int COMPILE_ENCODE_PROFILE_MAIN = 2
 main profile for video encode More...
 
static final int COMPILE_ENCODE_PROFILE_HIGH = 3
 High profile for video encode. More...
 
Configurations for recording

static final String RECORD_BITRATE = "bitrate"
 Record bitrate in bpsļ¼Œtype: int, such as 3000000 for 3M biterate. More...
 
static final String RECORD_GOP_SIZE = "gopsize"
 Record GOP size, type: int, default is 30. More...
 
static final String VIDEO_ENCODEC_NAME = "video encoder name"
 Assigned video encoding format, hevc(h.256) is supported, default is h.264. More...
 
static final String ENCORDER_COLOR_TRANSFER = "encorder color transfer"
 Set color transfer for HDR to encode, curve: string, default is "none", can support "st2084" and "hlg",. More...
 
Configurations for creating the timeline

static final String COMPILE_BITRATE = "bitrate"
 Compile bitrate in bpsļ¼Œtype: int, such as 3000000 for 3M biterate. More...
 
static final String COMPILE_GOP_SIZE = "gopsize"
 Compile GOP size, type: int, default is 30. More...
 
static final String COMPILE_AUDIO_BITRATE = "audio bitrate"
 Compile audio bitrate in bps, type: int, such as 128000 for 128k bitrate. More...
 
static final String COMPILE_LOSSLESS_AUDIO = "lossless audio"
 Whether to compile lossless audio, type: booleanļ¼Œdefault is false. More...
 
static final String COMPILE_OPTIMIZE_FOR_NETWORK_USE = "optimize-for-network-use"
 Whether to prepose the index table, type: booleanļ¼Œdefault is false. More...
 
static final String COMPILE_SOFTWARE_ENCODER_PRESET = "software encorder preset"
 Preset parameters for software encoder, type: string, default is "faster", can support "ultrafast"ļ¼Œ"superfast"ļ¼Œ"veryfast"ļ¼Œ"faster"ļ¼Œ "fast"ļ¼Œ"medium"ļ¼Œ"slow"ļ¼Œ"slower"ļ¼Œ"veryslow"ļ¼Œ"placebo". More...
 
static final String COMPILE_SOFTWARE_ENCODER_CRF = "software encorder crf"
 Preset crf parameters for software encoder, type: int, range is [1, 99], less is betterļ¼Œdefault is 23. More...
 
static final String COMPILE_SOFTWARE_ENCODER_CRF_BITRATE_MAX = "software encorder crf bitrate max"
 Preset maximum bitrate for software encoder in crf mode, type: int. More...
 
static final String COMPILE_SOFTWARE_ENCODER_MODE = "software encorder mode"
 Software encoder mode, type: string, support ā€œabrā€ć€ā€œcrfā€ļ¼Œdefault is crf. More...
 
static final String COMPILE_VIDEO_ENCODER_NAME = "video encoder name"
 Assigned video encoding format, "hevc"(h.265), "vp8"(The audio encoder must be Vorbis and the file format must be WebM) is supported, default is "h.264". More...
 
static final String COMPILE_AUDIO_ENCODER_NAME = "audio encoder name"
 Assigned audio encoding format, "amr-wb", "vorbis" and "mp3" are supported, default is "aac". More...
 
static final String COMPILE_CREATION_TIME = "creation time"
 Set creation time for this file. Foramt:"YYYY-MM-DDTHH:MM:SS",eg:2010-12-24T12:00:00(use location time) More...
 
static final String COMPILE_LOCATION = "location"
 Set location for this file. eg:17.641347+160.931648. More...
 
static final String COMPILE_USE_OPERATING_RATE = "use operating rate"
 Whether to use operating rate, type: boolean. More...
 
static final String COMPILE_FPS = "fps"
 frames per second when compiling, type: NvsRational More...
 
static final String COMPILE_VIDEO_ENCODER_PROFILE = "encorder profile"
 Assigned video encoding profile, type: int, values are 0 means none, 1 means baseline, 2 means main, 3 means high. More...
 
static final String COMPILE_VIDEO_HDR_COLOR_TRANSFER = "encorder color transfer"
 Set color transfer for HDR to encode, curve: string, default is "none", can support "st2084" and "hlg", and "hdr10plus",. More...
 
static final String COMPILE_VIDEO_ENABLE_BREAKPOINT_CONTINUATION = "enable breakpoint continuation"
 Set whether enable breakpoint continuation. More...
 
static final String COMPILE_VIDEO_CACHE_FILE_PATH = "cache file path"
 Breakpoint continuation cache file path. More...
 
static final String COMPILE_VIDEO_CACHE_FILE_DURATION = "cache file duration"
 Breakpoint continuation cache file duration. More...
 
static final String COMPILE_VIDEO_ENCODER_SUPPORT_ALPHA_CHANNEL = "alpha channel supported"
 Alpah channel is supported. Now, only VP8 format is supported. More...
 
static final String COMPILE_VIDEO_ENCODER_GIF_STATS_MODE = "gif stats mode"
 Set the statistical mode for GIF export. Currently, it supports diff, single, and defaults to single mode. If set to diff mode, it is best to export GIF for no more than 10 seconds. In this mode, memory requirements are relatively high. More...
 
static final String COMPILE_METADATADESCRIPTION = "metadata description"
 sets the metadata description of the video files More...
 
static final String COMPILE_VIDEO_BITRATE_MODE = "bitrate mode"
 Compile bitrate mode, Currently supported "cbr" and "vbr". More...
 
static final String COMPILE_AUDIO_SAMPLE_RATE = "audio sample rate"
 Set the audio sampling rate, currently supporting a minimum of 16K and a maximum of 128K. More...
 
static final String COMPILE_AUDIO_CHANNELS_MODE = "audio channels mode"
 Set up audio channels, currently supporting "mixtomono", with default and timeline settings consistent. More...
 
static final String COMPILE_FILE_META_DATA = "file metadata"
 Set meta data, for example:"creation-time=xxxxx;location=17.641347+160.931648;". More...
 
Error flags for capture device

static final int CAPTURE_DEVICE_ERROR_UNKNOWN = 1
 Unknown error with the capturing device. More...
 
static final int CAPTURE_DEVICE_ERROR_SERVER_DIED = 2
 Capture device's error, the server died. More...
 
static final int CAPTURE_DEVICE_ERROR_FAIL_TO_START = 3
 Capture device's error, the server died. More...
 
static final int CAPTURE_DEVICE_ERROR_FAIL_TO_CONNECT = 4
 
Size mode for preview

static final int VIDEO_PREVIEW_SIZEMODE_FULLSIZE = 0
 Full-screen preview mode. More...
 
static final int VIDEO_PREVIEW_SIZEMODE_LIVEWINDOW_SIZE = 1
 Livewindow size preview mode. More...
 
Video capture flag

static final int STREAMING_ENGINE_CAPTURE_FLAG_GRAB_CAPTURED_VIDEO_FRAME = 1
 Grabs frame from captured video (turnning on this flag would affect performance, turn on only when neccessary) More...
 
static final int STREAMING_ENGINE_CAPTURE_FLAG_DONT_USE_SYSTEM_RECORDER = 4
 Not using the system built-in recorder to record. More...
 
static final int STREAMING_ENGINE_CAPTURE_FLAG_STRICT_PREVIEW_VIDEO_SIZE = 8
 Resticts the preview video's size to system's built-in preview video size. More...
 
static final int STREAMING_ENGINE_CAPTURE_FLAG_DONT_CAPTURE_AUDIO = 16
 Does not record audio. More...
 
static final int STREAMING_ENGINE_CAPTURE_FLAG_CAPTURE_BUDDY_HOST_VIDEO_FRAME = 32
 Records buddy video frame, used to detect face. More...
 
static final int STREAMING_ENGINE_CAPTURE_FLAG_FACE_ACTION_WITH_PARTICLE = 256
 Uses face action to control particle special effects. More...
 
static final int STREAMING_ENGINE_CAPTURE_FLAG_LOW_PIPELINE_SIZE = 512
 Decreases the size of pipeline when engine is capturing. More...
 
static final int STREAMING_ENGINE_CAPTURE_FLAG_DISABLE_FLIP_FOR_FRONT_CAMERA = 2048
 Disable flip of front camera. More...
 
static final int STREAMING_ENGINE_CAPTURE_FLAG_INPUT_ASPECT_RATIO_USED = 4096
 Capture preview size aspect ratio use user input. More...
 
static final int STREAMING_ENGINE_CAPTURE_FLAG_ENABLE_TAKE_PICTURE = 8192
 Enable takc picture. More...
 
Video anti-shake mode

static final int VIDEO_STABILIZATION_MODE_OFF = 0
 Turns off the video anti-shake mode. More...
 
static final int VIDEO_STABILIZATION_MODE_AUTO = 1
 Sets on/off of the video stabilization mode to auto. More...
 
static final int VIDEO_STABILIZATION_MODE_STANDARD = 2
 Standard mode for video anti-shake mode. More...
 
static final int VIDEO_STABILIZATION_MODE_SUPER = 3
 Anti-shake movie mode. More...
 
Recording flags

static final int STREAMING_ENGINE_RECORDING_FLAG_VIDEO_INTRA_FRAME_ONLY = 2
 Records files that only include I-Frame. (Note: only works when using with STREAMING_ENGINE_CAPTURE_FLAG_DONT_USE_SYSTEM_RECORDER) More...
 
static final int STREAMING_ENGINE_RECORDING_FLAG_DISABLE_HARDWARE_ENCODER = 4
 Records without hardware encoder. More...
 
static final int STREAMING_ENGINE_RECORDING_FLAG_SOFTWARE_VIDEO_INTRA_FRAME_ONLY_FAST_STOP = 8
 Fast stop when recording I-Frame-only video with software encoder, this could result in a discard of video frame. More...
 
static final int STREAMING_ENGINE_RECORDING_FLAG_ONLY_RECORD_VIDEO = 16
 Only records video streams to file, all audio streams would not be recorded. More...
 
static final int STREAMING_ENGINE_RECORDING_FLAG_IGNORE_VIDEO_ROTATION = 32
 Video recorded is not rotated according to the capture device's orientation. (Note: only workds with STREAMING_ENGINE_CAPTURE_FLAG_DONT_USE_SYSTEM_RECORDER) More...
 
static final int STREAMING_ENGINE_RECORDING_FLAG_DONT_USE_INPUT_SURFACE = 64
 Does not use input surface. More...
 
static final int STREAMING_ENGINE_RECORDING_FLAG_DISABLE_MEDIA_MUXER = 128
 disable MediaMuxer More...
 
static final int STREAMING_ENGINE_RECORDING_FLAG_RECORDING_WITHOUT_FX = 256
 recording without fx, Remarkļ¼šit has only effects when using the flags of STREAMING_ENGINE_CAPTURE_FLAG_DONT_USE_SYSTEM_RECORDER More...
 
static final int STREAMING_ENGINE_RECORDING_FLAG_FLIP_HORIZONTALLY = 512
 Flip horizontally input video frame. More...
 
Take picture flags

static final int CAMERA_FLASH_MODE_OFF = 1
 Turns off flash. More...
 
static final int CAMERA_FLASH_MODE_ON = 2
 Turns On flash. More...
 
static final int CAMERA_FLASH_MODE_AUTO = 4
 Turns On flash to auto. More...
 
static final int CAMERA_FLASH_MODE_TORCH = 8
 Turns On torch. More...
 
Engine seek flag

static final int STREAMING_ENGINE_SEEK_FLAG_SHOW_CAPTION_POSTER = 2
 Shows the entire caption effects. More...
 
static final int STREAMING_ENGINE_SEEK_FLAG_SHOW_ANIMATED_STICKER_POSTER = 4
 Shows the entire animated sticker effects. More...
 
static final int STREAMING_ENGINE_SEEK_FLAG_BUDDY_HOST_VIDEO_FRAME = 16
 buddy video frame in host, used to detect face More...
 
static final int STREAMING_ENGINE_SEEK_FLAG_NOT_CONNECT_TO_LIVEWINDOW = 128
 Seek can be done without connecting to the LiveWindow. More...
 
static final int STREAMING_ENGINE_SEEK_FLAG_BUDDY_ORIGIN_VIDEO_FRAME = 256
 buddy video frame in host after decoding, used to detect face More...
 
Engine playback flag

static final int STREAMING_ENGINE_PLAYBACK_FLAG_LOW_PIPELINE_SIZE = 8
 Decreases the pipeline size of playback engine. More...
 
static final int STREAMING_ENGINE_PLAYBACK_FLAG_DISABLE_FIXED_PREROLL_TIME = 16
 Decreases the first frame lag of playback engine. More...
 
static final int STREAMING_ENGINE_PLAYBACK_FLAG_BUDDY_HOST_VIDEO_FRAME = 32
 buddy video frame in host, used to detect face More...
 
static final int STREAMING_ENGINE_PLAYBACK_FLAG_DISABLE_PRELOADER_ON_SOURCE = 64
 disable preloader on video source More...
 
static final int STREAMING_ENGINE_PLAYBACK_FLAG_AUTO_CACHE_ALL_CAF_FRAMES = 128
 Cache all frames of caf file. More...
 
static final int STREAMING_ENGINE_PLAYBACK_FLAG_SPEED_COMP_MODE = 512
 Playback with speed compensation. More...
 
static final int STREAMING_ENGINE_PLAYBACK_FLAG_BUDDY_ORIGIN_VIDEO_FRAME = 2048
 buddy video frame in host after decoding, used to detect face More...
 
static final int STREAMING_ENGINE_PLAYBACK_FLAG_VARIABLE_FRAME_RATE_ENABLE = 4096
 Enable variable frame rate playback, and the playback frame rate will change with the video frame rate. More...
 
static final int STREAMING_ENGINE_PLAYBACK_FLAG_DISABLE_DROP_FRAME_MODE = 16384
 Disable the frame dropping mode for playback. If this flag is not added, the SDK will ensure continuous audio playback. If the video rendering is complex and so on, it will use the frame dropping mode to ensure video and audio synchronization. More...
 
Engine compile flag

static final int STREAMING_ENGINE_COMPILE_FLAG_DISABLE_HARDWARE_ENCODER = 1
 Disables the hardware encoder. More...
 
static final int STREAMING_ENGINE_COMPILE_FLAG_DONT_USE_INPUT_SURFACE = 2
 Not using input surface. More...
 
static final int STREAMING_ENGINE_COMPILE_FLAG_ONLY_VIDEO = 4
 Generate file only with video stream. More...
 
static final int STREAMING_ENGINE_COMPILE_FLAG_ONLY_AUDIO = 8
 Generate file only with audio stream. More...
 
static final int STREAMING_ENGINE_COMPILE_FLAG_DISABLE_MEDIA_MUXER = 16
 disable MediaMuxer More...
 
static final int STREAMING_ENGINE_COMPILE_FLAG_BUDDY_HOST_VIDEO_FRAME = 32
 buddy video frame in host, used to detect face More...
 
static final int STREAMING_ENGINE_COMPILE_FLAG_DISABLE_PRELOADER_ON_SOURCE = 64
 disable preloader on video source More...
 
static final int STREAMING_ENGINE_COMPILE_FLAG_TRUNCATE_AUDIO_STREAM = 128
 Truncat audio stream make sure no longer than the length of the video. More...
 
static final int STREAMING_ENGINE_COMPILE_FLAG_DISABLE_ALIGN_VIDEO_SIZE = 256
 
static final int STREAMING_ENGINE_COMPILE_FLAG_USE_SOFTWARE_AUDIO_ENCODER = 1024
 Software audio encoder used. More...
 
static final int STREAMING_ENGINE_COMPILE_FLAG_IGNORE_TIMELINE_VIDEO_SIZE = 2048
 The resolution of output video can be over timeline's resolution. More...
 
static final int STREAMING_ENGINE_COMPILE_FLAG_LOW_PIPELINE_SIZE = 4096
 Use low pipeline size to decrease CPU/GPU usage during compilation. More...
 
static final int STREAMING_ENGINE_COMPILE_FLAG_BUDDY_ORIGIN_VIDEO_FRAME = 8192
 buddy video frame in host after decoding, used to detect face More...
 
static final int STREAMING_ENGINE_COMPILE_FLAG_VARIABLE_FRAME_RATE_ENABLE = 16384
 Enable variable frame rate export and the exported frame rate will change with the video frame rate. More...
 
Engine stop flag

static final int STREAMING_ENGINE_STOP_FLAG_FORCE_STOP_COMPILATION = 1
 Forces stop of compilation, resulting compiled file incomplete. More...
 
static final int STREAMING_ENGINE_STOP_FLAG_ASYNC = 2
 Stops the engine asynchronously to avoid blocking main thread. More...
 
static final int STREAMING_ENGINE_INTERRUPT_STOP = 4
 Interrupting the decoding thread without waiting for the decoding to complete and stopping quickly will result in the final picture may be incorrect. More...
 
Engine playback exception type

static final int STREAMING_ENGINE_PLAYBACK_EXCEPTION_TYPE_MEDIA_FILE_ERROR = 0
 Media file error. More...
 
Hardware error type

static final int STREAMING_ENGINE_HARDWARE_ERROR_TYPE_VIDEO_ENCODER_SETUP_ERROR = 0
 
static final int STREAMING_ENGINE_HARDWARE_ERROR_TYPE_VIDEO_ENCODING_ERROR = 1
 
static final int STREAMING_ENGINE_HARDWARE_ERROR_TYPE_VIDEO_DECODER_SETUP_ERROR = 2
 
static final int STREAMING_ENGINE_HARDWARE_ERROR_TYPE_VIDEO_DECODING_ERROR = 3
 
compile error type

static final int COMPILE_ERROR_TYPE_NO_ERROR = 0
 
static final int COMPILE_ERROR_TYPE_Cancelation = 1
 
static final int COMPILE_ERROR_TYPE_VIDEO_ENCODER_SETUP_ERROR = 2
 
static final int COMPILE_ERROR_TYPE_VIDEO_ENCODING_ERROR = 3
 
static final int COMPILE_ERROR_TYPE_VIDEO_DECODING_ERROR = 4
 
static final int COMPILE_ERROR_TYPE_MUXING_ERROR = 5
 
Rotation angle of input buffer image

static final int BUFFER_IMAGE_ROTATION_0 = 0
 
static final int BUFFER_IMAGE_ROTATION_90 = 1
 
static final int BUFFER_IMAGE_ROTATION_180 = 2
 
static final int BUFFER_IMAGE_ROTATION_270 = 3
 
Human detection features

static final int HUMAN_DETECTION_FEATURE_FACE_LANDMARK = 1
 Landmarks on human face. More...
 
static final int HUMAN_DETECTION_FEATURE_FACE_ACTION = 2
 Actions of human face. More...
 
static final int HUMAN_DETECTION_FEATURE_AVATAR_EXPRESSION = 4
 Avatar Expressions of human face. More...
 
static final int HUMAN_DETECTION_FEATURE_VIDEO_MODE = 8
 Video detection mode. More...
 
static final int HUMAN_DETECTION_FEATURE_IMAGE_MODE = 16
 Image detection mode. More...
 
static final int HUMAN_DETECTION_FEATURE_SEMI_IMAGE_MODE = 32768
 Semi-image detection mode. More...
 
static final int HUMAN_DETECTION_FEATURE_MULTI_THREAD = 32
 Multi thread detection. More...
 
static final int HUMAN_DETECTION_FEATURE_SINGLE_THREAD = 64
 Single thread detection. More...
 
static final int HUMAN_DETECTION_FEATURE_EXTRA = 128
 Extra features of human face. More...
 
static final int HUMAN_DETECTION_FEATURE_SEGMENTATION_BACKGROUND = 256
 Background segmentation. More...
 
static final int HUMAN_DETECTION_FEATURE_HAND_LANDMARK = 512
 Hand landmarks. More...
 
static final int HUMAN_DETECTION_FEATURE_HAND_ACTION = 1024
 Hand actions. More...
 
static final int HUMAN_DETECTION_FEATURE_HAND_BONE = 2048
 Bone landmarks of hand. More...
 
static final int HUMAN_DETECTION_FEATURE_EYEBALL_LANDMARK = 4096
 Eyeball landmarks. More...
 
static final int HUMAN_DETECTION_FEATURE_MULTI_DETECT = 8192
 Multiple detect, say multiple rois detection. More...
 
static final int HUMAN_DETECTION_FEATURE_SEGMENTATION_SKY = 16384
 Sky segmentation. More...
 
static final int HUMAN_DETECTION_FEATURE_SEGMENTATION_HALF_BODY = 65536
 Half body segmentation. More...
 
static final int HUMAN_DETECTION_FEATURE_FACE_ATTR = 131072
 Base face attributes. More...
 
static final int HUMAN_DETECTION_FEATURE_FACE_ATTR_SHAPE = 262144
 
Type of human detection data pack

static final int HUMAN_DETECTION_DATA_TYPE_FAKE_FACE = 0
 Fake face data pack type. More...
 
static final int HUMAN_DETECTION_DATA_TYPE_MAKEUP = 1
 Makeup data pack type. More...
 
static final int HUMAN_DETECTION_DATA_TYPE_SKIN_COLOR = 2
 Skin color data pack type. More...
 
static final int HUMAN_DETECTION_DATA_TYPE_PE106 = 3
 PE 106 data pack type. More...
 
static final int HUMAN_DETECTION_DATA_TYPE_PE240 = 4
 PE 240 data pack type. More...
 
static final int HUMAN_DETECTION_DATA_TYPE_CUSTOM_AVATAR = 5
 Custom avatar data pack type. More...
 
static final int HUMAN_DETECTION_DATA_TYPE_MAKEUP2 = 6
 Makeup2 data pack type. More...
 
Engine sends buffer flag

static final int STREAMING_ENGINE_SEND_BUFFER_FLAG_ONLY_FOR_GRAB = 1
 
static final int STREAMING_ENGINE_SEND_BUFFER_FLAG_ONLY_FOR_BUDDY = 2
 Data only used for handeling buddy video captured's frame content. More...
 
Speical flags when capturing video and audio information

static final int AV_FILEINFO_EXTRA_NULL = 0
 
static final int AV_FILEINFO_EXTRA_PIXELFORMAT = 1
 
static final int AV_FILEINFO_EXTRA_VIDEO_CODEC_ID = 2
 
static final int AV_FILEINFO_EXTRA_INFO = AV_FILEINFO_EXTRA_PIXELFORMAT
 
Aspect ratio supported by the resource package

static final int ASSET_PACKAGE_ASPECT_RATIO_16v9 = 1
 
static final int ASSET_PACKAGE_ASPECT_RATIO_1v1 = 2
 
static final int ASSET_PACKAGE_ASPECT_RATIO_9v16 = 4
 
static final int ASSET_PACKAGE_ASPECT_RATIO_4v3 = 8
 
static final int ASSET_PACKAGE_ASPECT_RATIO_3v4 = 16
 
static final int ASSET_PACKAGE_ASPECT_RATIO_18v9 = 32
 
static final int ASSET_PACKAGE_ASPECT_RATIO_9v18 = 64
 
Create timeline flag

static final int CREATE_TIMELINE_FLAG_LONGEST_DURATION_CONSIDER_ALL_TRACKS = 1
 timeline's longest duration consider all tracks More...
 
static final int CREATE_TIMELINE_FLAG_SYANC_AUDIO_VIDEO_TRANS_ON_VIDEO_TRACK = 2
 Sync audio transition and video transiton on video track. More...
 
static final int CREATE_TIMELINE_FLAG_USE_MIPMAP = 4
 Use mipmap anti-aliasing. More...
 
static final int CREATE_TIMELINE_FLAG_VARIANT_IMAGE_SIZE = 8
 Automatically adapt timeline resolution when add images. More...
 
static final int CREATE_TIMELINE_FLAG_DONT_ADD_DEFAULT_VIDEO_TRANSITION = 16
 Do not add a default video transition. More...
 
static final int CREATE_TIMELINE_FLAG_ORPHAN = 128
 Orphan timeline flag, destroy the timeline after its parent timeline destroyed. More...
 
static final int CREATE_TIMELINE_FLAG_TIMELINE_SIZE_USED_IN_VARIANT_SIZE_MODE = 256
 
HDR capability flags

static final int HDR_CAPABILITY_FLAG_SUPPORTED_BY_IMPORTER = 1
 Support importing HDR video. More...
 
static final int HDR_CAPABILITY_FLAG_SUPPORTED_BY_EDITING = 2
 Editing Support HDR. More...
 
static final int HDR_CAPABILITY_FLAG_SUPPORTED_BY_EXPORTER = 4
 Support exporting HDR video. More...
 
static final int HDR_CAPABILITY_FLAG_SUPPORTED_BY_LIVEWINDOW = 8
 Livewindow support HDR. More...
 
device power levelļ¼Œcpu and gpu

Since
3.8.0
static final int DEVICE_POWER_LEVEL_UNKNOWN = -1
 unknown level More...
 
static final int DEVICE_POWER_LEVEL_LOW = 0
 low level More...
 
static final int DEVICE_POWER_LEVEL_MEDIUM = 1
 medium level More...
 
static final int DEVICE_POWER_LEVEL_HIGH = 2
 

Protected Member Functions

void setInternalObject (long internalObject)
 
long getInternalObject ()
 
boolean isAuxiliaryContext ()
 

Detailed Description

Streaming context.

The streaming context class(NvsStreamingContext) can be refered to as the entry point of the whole SDK framework. In the process of development, NvsStreamingContext provides the static sharedInstance interface, which is the only instance to create streaming context. Through this instantce object, we can turn on the recording device to record videos, adding effects to capture videos, set various parameters for recording, which include autofocus, automatic exposure adjustment, swtiching on/off of the light supplement and so on. Meanwhile, this instance can also create timelines, connecting timelines to real-time preview windows to view the recorded videos in real-time. When the whole video has been produced completely, please destroy the instances of streaming context. When recording with special effects or adding resources packages (recording effects package, scene resources package and so on), one has to first install the package and obtain packageID after installation. For built-in special effects, one only needs to obtain the name of the effect in order to use them.
In the SDK, users need to adopt the full pathway when importing resources or authorizations.

Warning
For NvsStreamingContext class, all public APIs must be used in the UI thread except getAVFileInfo(), detectVideoFileKeyframeInterval(),createVideoFrameRetriever(), which can be used across threads.

Member Function Documentation

◆ addCustomCaptureAnimatedSticker()

NvsCaptureAnimatedSticker com.meicam.sdk.NvsStreamingContext.addCustomCaptureAnimatedSticker ( long  inPoint,
long  duration,
String  animatedStickerPackageId,
String  customImagePath 
)
inline

Add a custom animated sticker on capture.

Parameters
inPointThe in point of custom animated sticker on the timeline (in microseconds)
durationThe duration of custom animation sticker which displayed (in microseconds)
animatedStickerPackageIdAnimated sticker package Id
customImagePathPath of custom animated sticker image(It can be a jpg, png image, or a dynamic caf format image supported by Meishe sdk)
Returns
Return the NvsCaptureAnimatedSticker object.
It will return nil in the following situations:
1. No animated sticker function authorization;
2. The animatedStickerPackageId is empty or nil;
3. The animatedSticker has not install successed;
4. If inPoint is less than 0, or duration is not greater than 0.
Note: If the return value is not nil, you still cannot see the sticker effect, you need to check whether the customImagePath actually exists.
See also
removeCaptureAnimatedSticker:
Since
3.2.0

◆ appendBeautyCaptureVideoFx()

NvsCaptureVideoFx com.meicam.sdk.NvsStreamingContext.appendBeautyCaptureVideoFx ( )
inline

Appends a beauty effect.

Returns
Returns the Appended NvsCaptureVideoFx object.
See also
insertBeautyCaptureVideoFx

◆ appendBuiltinCaptureAudioFx()

NvsCaptureAudioFx com.meicam.sdk.NvsStreamingContext.appendBuiltinCaptureAudioFx ( String  audioFxName)
inline

Appends a built-in capture audio effect.

Parameters
audioFxNameaudio effect name. To get the audio effect name, please refer to getAllBuiltinCaptureAudioFxNames() or The List of Built-in Effect Name.
Returns
Returns the appended NvsCaptureAudioFx object.
See also
insertBuiltinCaptureVideoFx
Since
2.18.0

◆ appendBuiltinCaptureVideoFx()

NvsCaptureVideoFx com.meicam.sdk.NvsStreamingContext.appendBuiltinCaptureVideoFx ( String  videoFxName)
inline

Appends a built-in capture video effect.

Parameters
videoFxNameVideo effect name. To get the video effect name, please refer to getAllBuiltinCaptureVideoFxNames() or The List of Built-in Effect Name.
Returns
Returns the appended NvsCaptureVideoFx object.
See also
insertBuiltinCaptureVideoFx

◆ appendCaptureAnimatedSticker()

NvsCaptureAnimatedSticker com.meicam.sdk.NvsStreamingContext.appendCaptureAnimatedSticker ( long  offsetTime,
long  duration,
String  animatedStickerPackageId 
)
inline

Appends a animated sticker.

Parameters
offsetTimeanimated sticker's offset time.
durationanimated sticker's duration.
animatedStickerPackageIdAnimated sticker package Id.
Returns
Returns the appended NvsCaptureAnimatedSticker object.
It will return null in the following situations:
1. No animated sticker function authorization;
2. The animatedStickerPackageId is empty or null;
3. The animatedSticker has not install successed;
See also
insertCaptureAnimatedSticker
Since
2.21.0

◆ appendCaptureCaption()

NvsCaptureCaption com.meicam.sdk.NvsStreamingContext.appendCaptureCaption ( String  captionText,
long  offsetTime,
long  duration,
String  captionStylePackageId 
)
inline

Appends a caption.

Parameters
captionTextText of caption
offsetTimecatpion's offset time.
durationcatpion's duration.
captionStylePackageIdCaption style package Id.If it does not exist, you can pass an empty string or null.
Returns
Returns the appended NvsCaptureCaption object.
It will return null in the following situations:
1. No compound caption function authorization;
See also
insertCaptureCompoundCaption
Since
2.21.0

◆ appendCaptureCompoundCaption()

NvsCaptureCompoundCaption com.meicam.sdk.NvsStreamingContext.appendCaptureCompoundCaption ( long  offsetTime,
long  duration,
String  compoundCaptionPackageId 
)
inline

Appends a compound caption.

Parameters
offsetTimecompound catpion's offset time.
durationcompound catpion's duration.
compoundCaptionPackageIdCaption style package Id.If it does not exist, you can pass an empty string or null.
Returns
Returns the appended NvsCaptureCompoundCaption object.
It will return null in the following situations:
1. No compound caption function authorization;
See also
insertCaptureCompoundCaption
Since
2.21.0

◆ appendCaptureModularCaption()

NvsCaptureCaption com.meicam.sdk.NvsStreamingContext.appendCaptureModularCaption ( String  captionText,
long  offsetTime,
long  duration 
)
inline

Appends a modular caption.

Parameters
captionTextText of caption
offsetTimecatpion's offset time.
durationcatpion's duration.
Returns
Returns the appended NvsCaptureCaption object.
It will return null in the following situations:
1. No compound caption function authorization;
See also
insertCaptureCompoundCaption
Since
2.21.0

◆ appendCustomCaptureVideoFx()

NvsCaptureVideoFx com.meicam.sdk.NvsStreamingContext.appendCustomCaptureVideoFx ( NvsCustomVideoFx.Renderer  customVideoFxRender)
inline

Appends a custom capture video effect.

Parameters
customVideoFxRenderInterface of user-implemented custom video effect renderer
Returns
Returns the appended NvsCaptureVideoFx object.
Warning
This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.
Since
1.7.0

◆ appendPackagedCaptureVideoFx()

NvsCaptureVideoFx com.meicam.sdk.NvsStreamingContext.appendPackagedCaptureVideoFx ( String  videoFxPackageId)
inline

Appends a package capture effectx.

Parameters
videoFxPackageIdVideo effect package ID
Returns
Returns the appended NvsCaptureVideoFx object.
See also
insertPackagedCaptureVideoFx

◆ applyCaptureScene() [1/2]

boolean com.meicam.sdk.NvsStreamingContext.applyCaptureScene ( String  captureSceneId)
inline

Apply a capture scene resource package to the capture device.

Parameters
captureSceneIdThe ID of capture scene resource package
Returns
Returns a BOOL value. A value of YES will result in a successful application and NO means it fails to apply.
Since
1.2.0
See also
getCurrentCaptureSceneId
removeCurrentCaptureScene

◆ applyCaptureScene() [2/2]

boolean com.meicam.sdk.NvsStreamingContext.applyCaptureScene ( String  captureSceneId,
NvsCaptureSceneInfo  info 
)
inline

Apply a capture scene resource package to the capture device.

Parameters
captureSceneIdThe ID of capture scene resource package
infoResource information to be replaced
Returns
Returns a BOOL value. A value of YES will result in a successful application and NO means it fails to apply.
Since
3.2.0
See also
getCurrentCaptureSceneId
removeCurrentCaptureScene

◆ calcDurationAfterCurvesVariableSpeed()

long com.meicam.sdk.NvsStreamingContext.calcDurationAfterCurvesVariableSpeed ( String  curvesString)
inline

calc the duration after use curves variable speed.noteļ¼š the origin duration is the curves's last endpoint.x-first endpoint.x

Parameters
curvesStringdescription of the variable speed curves. \string foramt : (endpoint1)(endpoint1.backward)(endpoint1.frontward)(endpoint2)(endpoint2.backward)(endpoint2.frontward)ā€¦ā€¦ \coords foramt : (x,y) \note1 : the y coords means the multiple speed. the range of y is 0.1 to 10 \note2 : all x coord values cannot be repeated. endpoint1.backward.x < endpoint1.x < endpoint1.frontward.x < endpoint2.backward.x <endpoint2.xā€¦ā€¦ \note3 : if you set an empty curvesString,it means you want to disable curves variable speed,the clip will back to const speed. \eg : curvesString = "(0,1)(-3,1)(3,1)(7,5)(6,5)(8,5)(10,0.4)(9,0.4)(11,0.4)(17,0.4)(16,0.4)(18,0.4)(20,5)(19,5)(21,5)(27,1)(24,1)(30,1)" curvesString included 6 group end point info .

čæ”回ē»čæ‡ę›²ēŗæ变速后ēš„ę—¶é•æ怂ę³Øļ¼šåŽŸå§‹ę—¶é•æäøŗę›²ēŗæꮵäø­å°¾ē«Æē‚¹äøŽé¦–ē«Æē‚¹Xåę ‡å€¼ä¹‹å·®

Parameters
curvesStringč“å”žå°”ę›²ēŗæꏏčæ°å­—ē¬¦äø² \字ē¬¦äø²ę ¼å¼ļ¼š(ē«Æē‚¹1åę ‡)(ē«Æē‚¹1åŽęŽ§åˆ¶ē‚¹åę ‡)(ē«Æē‚¹1å‰ęŽ§åˆ¶ē‚¹åę ‡)(ē«Æē‚¹2åę ‡)(ē«Æē‚¹2åŽęŽ§åˆ¶ē‚¹åę ‡)(ē«Æē‚¹2å‰ęŽ§åˆ¶ē‚¹åę ‡)(ē«Æē‚¹3åę ‡)(ē«Æē‚¹3åŽęŽ§åˆ¶ē‚¹åę ‡)(ē«Æē‚¹3å‰ęŽ§åˆ¶ē‚¹åę ‡)ā€¦ā€¦ \åę ‡ę ¼å¼ļ¼š(åę ‡X值ļ¼Œåę ‡Y值) \ę³Ø1ļ¼šYåę ‡äøŗę’­ę”¾å€é€Ÿå€¼ļ¼ŒčŒƒå›“åœØ0.1-10ä¹‹é—“ć€‚ \ę³Ø2ļ¼šęƏäøŖē«Æē‚¹åŠęŽ§åˆ¶ē‚¹ēš„Xåę ‡åæ…é”»äøčƒ½ē›øē­‰ć€‚å¤§å°č§„å®šäøŗļ¼šē«Æē‚¹1åŽęŽ§åˆ¶ē‚¹ēš„Xåę ‡ < ē«Æē‚¹1ēš„Xåę ‡ <ē«Æē‚¹1ēš„å‰ęŽ§åˆ¶ē‚¹ēš„Xåę ‡ < ē«Æē‚¹2åŽęŽ§åˆ¶ē‚¹ēš„Xåę ‡ < ē«Æē‚¹2ēš„Xåę ‡ā€¦ā€¦ \ę³Ø3ļ¼šå¦‚ęžœč®¾ē½®ēš„curvesStringäøŗē©ŗ字ē¬¦äø²ļ¼Œåˆ™č”Øē¤ŗåƹčÆ„ē‰‡ę®µå–ę¶ˆä¹‹å‰ēš„ę›²ēŗæ变速ļ¼Œę¢å¤åˆ°åŒ€é€ŸēŠ¶ę€ć€‚ \例如ļ¼šcurvesString = "(0,1)(-3,1)(3,1)(7,5)(6,5)(8,5)(10,0.4)(9,0.4)(11,0.4)(17,0.4)(16,0.4)(18,0.4)(20,5)(19,5)(21,5)(27,1)(24,1)(30,1)"包含äŗ†6ē»„ē«Æē‚¹åŠå…¶ęŽ§åˆ¶ē‚¹åę ‡äæ”ęÆ怂
Since
2.17.0

◆ cancelAutoFocus()

void com.meicam.sdk.NvsStreamingContext.cancelAutoFocus ( )
inline

Cancels the ongoing autofocus.

See also
startAutoFocus

◆ checkDontSetCameraParamOnRecordingWithSystemRecorder()

boolean com.meicam.sdk.NvsStreamingContext.checkDontSetCameraParamOnRecordingWithSystemRecorder ( )
inline

Checks if the camera's parameters cannot be set when recording with system recorder.

For certain Android mobile phones, when recording with system built-in recorders, if one set cameras' parameters (for instance the exposure compensation or autofocus), the recorded video will have problems or the recording cannot be stopped. To avoid this kind of problems, the Meishe SDK keeps a blacklist of unwantted Android phones. If a phone is in the blacklist, any setting of the parameters while recording will be ignored. This method is used to check if current phone used is in the blacklist. If yes, the user may have to make certain adjustment to the recording interface, say disabling the exposure compensation button. Note: if the user does not use the system built-in recorder when recording, then the blacklist will not work.

Since
1.4.1

◆ clearCachedResources() [1/2]

void com.meicam.sdk.NvsStreamingContext.clearCachedResources ( boolean  asynchronous)
inline

Clears cached resources.

Parameters
asynchronousWhether to set it to asynchronous mode

◆ clearCachedResources() [2/2]

void com.meicam.sdk.NvsStreamingContext.clearCachedResources ( boolean  asynchronous,
int  flags 
)
inline

Clears cached resources.

Parameters
asynchronousWhether to set it to asynchronous mode

◆ close()

static void com.meicam.sdk.NvsStreamingContext.close ( )
inlinestatic

Destroys the streaming context object instance. note: it can be created again after destruction.

See also
init
getInstance

◆ closeHumanDetection()

static void com.meicam.sdk.NvsStreamingContext.closeHumanDetection ( )
inlinestatic

Turns off the human detection mechanism.

See also
initHumanDetection
Since
2.5.0

◆ compilePassthroughTimeline()

boolean com.meicam.sdk.NvsStreamingContext.compilePassthroughTimeline ( NvsTimeline  timeline,
String  outputFilePath,
Hashtable< String, Object >  compileConfigurations,
int  flags 
)
inline

Compile passthrough the video clips on video track 0 in the timeline into a file without processing filter, multi track and nested timeline. If there are photos, it will fail.

Parameters
timelineTimeline
outputFilePathThe path of output file.
configurationsthe timeline configurations, only supports COMPILE_CREATION_TIME, COMPILE_OPTIMIZE_FOR_NETWORK_USE and COMPILE_METADATADESCRIPTION
flagsSpecial flags for output file. If there is no special requirements please input 0.only supports STREAMING_ENGINE_COMPILE_FLAG_ONLY_VIDEO
Returns
Returns a boolean value. Note: compiling timeline to file is an asynchronous operation. Returns true if compile successful and false if compile failed.
Warning
This interface will trigger streaming engine to jump to stop state. For detailed situations please refer to the state changes of engine.
Since
3.4.0
See also
seekTimeline
playbackTimeline
compileTimeline

◆ compileTimeline() [1/2]

boolean com.meicam.sdk.NvsStreamingContext.compileTimeline ( NvsTimeline  timeline,
long  startTime,
long  endTime,
String  outputFilePath,
int  videoResolutionGrade,
int  videoBitrateGrade,
Hashtable< String, Object >  compileConfigurations,
int  flags 
)
inline

Compiles timeline into a file.

Parameters
timelineTimeline
startTimeStart time in microseconds. Start time should be in the range of [0, timeline.duration-1], other input value is invalid.
endTimeEnd time in microseconds. End time should be within [startTime,timeline.duration], other values are invalid.
outputFilePathThe path of output file.
videoResolutionGradeResolution grade of the output file. This grade means the height of compiled video and it can not be greater than the height of timeline. please refer to compile video resolution grade
videoBitrateGradeBitrate of the file compiled. Please refer to compile bitrate grade. The output bitrate can be low-bitrate, medium-bitrate or high-bitrate. The specific bitrate of video compiled is correlated with compiled file's resolution. Taking a 1280*720 pixels video for example, the approximate bitrate of low grade is 2.2Mbps, with 3.3Mbps for medium grade and 6.7Mbps for high grade.
configurationsthe timeline configurations. For key values in Hashtable please refer to Configuration of compiling timeline
flagsSpecial flags for output file. If there is no special requirements please input 0. Please refer to streaning engine compile flag.
Returns
Returns a boolean value. Note: compiling timeline to file is an asynchronous operation. Returns true if compile is successful and false if compile fails.
Warning
This interface will trigger streaming engine to jump to stop state. For detailed situations please refer to the state changes of engine.
Since
3.1.0
See also
seekTimeline
playbackTimeline

◆ compileTimeline() [2/2]

boolean com.meicam.sdk.NvsStreamingContext.compileTimeline ( NvsTimeline  timeline,
long  startTime,
long  endTime,
String  outputFilePath,
int  videoResolutionGrade,
int  videoBitrateGrade,
int  flags 
)
inline

Compiles timeline into a file.

Parameters
timelineTimeline
startTimeStart time in microseconds. Start time should be in the range of [0, timeline.duration-1], other input value is invalid.
endTimeEnd time in microseconds. End time should be within [startTime,timeline.duration], other values are invalid.
outputFilePathThe path of output file.
videoResolutionGradeResolution grade of the output file. This grade means the height of compiled video and it can not be greater than the height of timeline. please refer to compile video resolution grade
videoBitrateGradeBitrate of the file compiled. Please refer to compile bitrate grade. The output bitrate can be low-bitrate, medium-bitrate or high-bitrate. The specific bitrate of video compiled is correlated with compiled file's resolution. Taking a 1280*720 pixels video for example, the approximate bitrate of low grade is 2.2Mbps, with 3.3Mbps for medium grade and 6.7Mbps for high grade.
flagsSpecial flags for output file. If there is no special requirements please input 0. Please refer to streaning engine compile flag.
Returns
Returns a boolean value. Note: compiling timeline to file is an asynchronous operation. Returns true if compile is successful and false if compile fails.
Warning
This interface will trigger streaming engine to jump to stop state. For detailed situations please refer to the state changes of engine.
See also
seekTimeline
playbackTimeline

◆ connectCapturePreviewWithLiveWindow()

boolean com.meicam.sdk.NvsStreamingContext.connectCapturePreviewWithLiveWindow ( NvsLiveWindow  liveWindow)
inline

Connects the captured preview with live window.

Parameters
liveWindowLive window for previewing
Returns
Returns the boolean value. YES indicates a successful connection, and NO means the opposite.
See also
connectTimelineWithLiveWindow

◆ connectCapturePreviewWithLiveWindowExt()

boolean com.meicam.sdk.NvsStreamingContext.connectCapturePreviewWithLiveWindowExt ( NvsLiveWindowExt  liveWindow)
inline

Connects the captured preview with live windowļ¼ˆbased on TextureViewļ¼‰

Parameters
liveWindowLive window for previewing
Returns
Returns the boolean value. YES indicates a successful connection, and NO means the opposite.
See also
connectTimelineWithLiveWindowExt
Since
1.15.0

◆ connectCapturePreviewWithSurfaceTexture()

boolean com.meicam.sdk.NvsStreamingContext.connectCapturePreviewWithSurfaceTexture ( SurfaceTexture  outputSurfaceTexture)
inline

Connects a capture preview with a SurfaceTexture object. The capture preview's rendering result will be output to this SurfaceTexture object.

Parameters
outputSurfaceTextureThe SurfaceTexture object which rendering result will be output.
Returns
Returns a boolean value, true means connection succeeded and false means it failed.
Since
1.7.1

◆ connectTimelineWithLiveWindow()

boolean com.meicam.sdk.NvsStreamingContext.connectTimelineWithLiveWindow ( NvsTimeline  timeline,
NvsLiveWindow  liveWindow 
)
inline

Connects timeline with the LiveWindow.

Parameters
timelineTimeline
liveWindowPreview image window in real time
Returns
Returns a boolean value, true means a successful connection and false means failure

◆ connectTimelineWithLiveWindowExt()

boolean com.meicam.sdk.NvsStreamingContext.connectTimelineWithLiveWindowExt ( NvsTimeline  timeline,
NvsLiveWindowExt  liveWindow 
)
inline

Connects timeline with the LiveWindow (based on TextureView)

Parameters
timelineTimeline
liveWindowPreview image window in real time
Returns
Returns a boolean value, true means a successful connection and false means failure
Since
1.15.0

◆ connectTimelineWithSurfaceTexture() [1/2]

boolean com.meicam.sdk.NvsStreamingContext.connectTimelineWithSurfaceTexture ( NvsTimeline  timeline,
SurfaceTexture  outputSurfaceTexture 
)
inline

Connects timeline with a SurfaceTexture, of which the rendering outcome of the timeline will be output to this SurfaceTexture.

Parameters
timelineTimeline
outputSurfaceTextureThe SurfaceTexture object that rendering outcome output to
Returns
Returns a boolean value. true means a successful connection and false means failure
Since
1.5.0

◆ connectTimelineWithSurfaceTexture() [2/2]

boolean com.meicam.sdk.NvsStreamingContext.connectTimelineWithSurfaceTexture ( NvsTimeline  timeline,
SurfaceTexture  outputSurfaceTexture,
NvsRational  proxyScale 
)
inline

Connects timeline with SurfaceTexture and set the proxy scale. The timeline's rendering outcome will be output to this SurfaceTexture.

Parameters
timelineTimeline
outputSurfaceTextureThe SurfaceTexture object that rendering outcome output to
proxyScaleScale of proxy
Returns
Returns a boolean value, true means a successful connection and false means failure
Since
1.6.0

◆ connectTimelineWithVideoFrameReceiver()

boolean com.meicam.sdk.NvsStreamingContext.connectTimelineWithVideoFrameReceiver ( NvsTimeline  timeline,
VideoFrameReceiver  receiver,
NvsRational  proxyScale,
int  flags 
)
inline

Connects timeline with video frame receiver and set the proxy scale.

Parameters
timelineTimeline
receiverVideo frame receiver
proxyScaleScale of proxy
flagsFlags for video frame receicer. For specific please refer to video frame receicer flags
Returns
Returns a boolean value, true means a successful connection and false means failure
Since
3.5.0

◆ createAuxiliaryStreamingContext()

NvsStreamingContext com.meicam.sdk.NvsStreamingContext.createAuxiliaryStreamingContext ( int  flags)
inline

Creates an object of auxiliary streaming context.

Parameters
lagsFlag field. If there is no special requirement, please fill in 0.
Returns
Returns an NvsStreamingContext object .
Since
2.12.0
2.12.0

◆ createTimeline() [1/5]

NvsTimeline com.meicam.sdk.NvsStreamingContext.createTimeline ( NvsVideoResolution  videoEditRes,
NvsRational  videoFps,
NvsAudioResolution  audioEditRes 
)
inline

Creates timeline.

Parameters
videoEditResVideo file's resolution (specified width to height ratio). For video editting resolution, when importing corresponding params, the imported image's width has to be a multiple of 4, the height has to be a multiple of 2. Note: if one creates NvsStreamingContext's instance that supports 4K video editting, then video editting's resolution cannot be higher then 3840*2160(imageWidth*imageHeight), otherwise the imageWidth*imageHeight cannot exceed 1920* 1080 pixels.
videoFpsFrame rate
audioEditResAudio file's resolution(specified file sampling rate, sampling format and number of channels. For audio editting resolution, imported audio only supports two types of sampling rate, 44100 or 48000.)
Returns
Returns created timeline objectļ¼Œreturn null if params are invalid
See also
removeTimeline

◆ createTimeline() [2/5]

NvsTimeline com.meicam.sdk.NvsStreamingContext.createTimeline ( NvsVideoResolution  videoEditRes,
NvsRational  videoFps,
NvsAudioResolution  audioEditRes,
int  flags 
)
inline

Creates timeline.

Parameters
videoEditResVideo file's resolution (specified width to height ratio). For video editting resolution, when importing corresponding params, the imported image's width has to be a multiple of 4, the height has to be a multiple of 2. Note: if one creates NvsStreamingContext's instance that supports 4K video editting, then video editting's resolution cannot be higher then 3840*2160(imageWidth*imageHeight), otherwise the imageWidth*imageHeight cannot exceed 1920* 1080 pixels.
videoFpsFrame rate
audioEditResAudio file's resolution(specified file sampling rate, sampling format and number of channels. For audio editting resolution, imported audio only supports two types of sampling rate, 44100 or 48000.)
flagsSpecial flags for create timeline. If there is no special requirements please input 0. Please refer to create timeline flag.
Returns
Returns created timeline objectļ¼Œreturn null if params are invalid
Since
2.21.0
See also
removeTimeline

◆ createTimeline() [3/5]

NvsTimeline com.meicam.sdk.NvsStreamingContext.createTimeline ( String  templateId,
List< templateFootageInfo templateFootages 
)
inline

Creates timeline.

Parameters
templateIdtemplate uuidļ¼Œtemplate must be installed firstly
templateFootagesfootage information in the template asset
Returns
Returns created timeline object
See also
removeTimeline

◆ createTimeline() [4/5]

NvsTimeline com.meicam.sdk.NvsStreamingContext.createTimeline ( String  templateId,
List< templateFootageInfo templateFootages,
int  flags 
)
inline

Creates timeline.

Parameters
templateIdtemplate uuidļ¼Œtemplate must be installed firstly
templateFootagesfootage information in the template asset
flagsSpecial flags for create timeline. If there is no special requirements please input 0. Please refer to create timeline flag.
Returns
Returns created timeline object
Since
2.21.0
See also
removeTimeline

◆ createTimeline() [5/5]

NvsTimeline com.meicam.sdk.NvsStreamingContext.createTimeline ( String  templateId,
List< templateFootageInfo templateFootages,
int  flags,
NvsRational  videoFps,
NvsAudioResolution  audioResolution 
)
inline

Creates timeline.

Parameters
templateIdtemplate uuidļ¼Œtemplate must be installed firstly
templateFootagesfootage information in the template asset
flagsSpecial flags for create timeline. If there is no special requirements please input 0. Please refer to create timeline flag.
videoFpsFrame rate
audioEditResAudio file's resolution(specified file sampling rate, sampling format and number of channels. For audio editting resolution, imported audio only supports two types of sampling rate, 44100 or 48000.)
Returns
Returns created timeline object
Since
3.5.0
See also
removeTimeline

◆ createVideoFrameRetriever()

NvsVideoFrameRetriever com.meicam.sdk.NvsStreamingContext.createVideoFrameRetriever ( String  videoFilePath)
inline

Creates an object of video frame retriever.

Parameters
videoFilePathPath of the original video
Returns
Returns an NvsVideoFrameRetriever object representing the video frame retriever object.
Since
1.2.0

◆ destoryAuxiliaryStreamingContext()

void com.meicam.sdk.NvsStreamingContext.destoryAuxiliaryStreamingContext ( NvsStreamingContext  auxContext)
inline

destory auxiliary streaming context.

Parameters
NvsStreamingContext.destoryed auxiliary streaming context
Since
2.12.0
2.12.0

◆ detectEngineRenderFramePerSecond()

float com.meicam.sdk.NvsStreamingContext.detectEngineRenderFramePerSecond ( )
inline

Get engine render fps, only valid after calling StartCapturePreview or PlaybackTimeline.

Returns
Return engine render fps

◆ detectVideoFileKeyframeInterval()

int com.meicam.sdk.NvsStreamingContext.detectVideoFileKeyframeInterval ( String  videoFilePath)
inline

Detects video file's I-Frame interval.

Parameters
videoFilePathFile path of the vidio file
Returns
Returns the detected interval of I-Frame, returns 0 means detection failed
Since
1.6.0

◆ exportProjectInfo()

boolean com.meicam.sdk.NvsStreamingContext.exportProjectInfo ( String  projectUuid,
NvsTimeline  timeline,
int  requestedAspectRatio 
)
inline

Export project information.

Parameters
projectUuidProject resource package ID
timelineTimeline Object
requestedAspectRatioAspect ratio of project according to timeline怂please refer to Aspect ratio supported by the resource package
Returns
Returns suc or not

◆ exportTemplateInfo()

boolean com.meicam.sdk.NvsStreamingContext.exportTemplateInfo ( String  templateUuid,
NvsTimeline  timeline,
int  requestedAspectRatio 
)
inline

Export template information.

Parameters
templateUuidTemplate resource package ID
timelineTimeline Object
requestedAspectRatioAspect ratio of template according to timeline怂please refer to Aspect ratio supported by the resource package
Returns
Returns suc or not

◆ generateProjectPackage()

boolean com.meicam.sdk.NvsStreamingContext.generateProjectPackage ( String  projectUuid,
String  innerAssetDir,
String  projectOutputDir 
)
inline

Generate project asset package.

Parameters
projectUuidproject resource package ID
innerAssetDirPath of internal assets of template
projectOutputDirOutput path of project asset package
Returns
Returns suc or not
Since
3.3.2

◆ generateTemplatePackage()

boolean com.meicam.sdk.NvsStreamingContext.generateTemplatePackage ( String  templateUuid,
String  innerAssetDir,
String  templateOutputDir 
)
inline

Generate template asset package.

Parameters
templateUuidTemplate resource package ID
innerAssetDirPath of internal assets of template
templateOutputDirOutput path of template asset package
Returns
Returns suc or not

◆ getAllBuiltinAudioFxNames()

List<String> com.meicam.sdk.NvsStreamingContext.getAllBuiltinAudioFxNames ( )
inline

Gets the list of all built-in audio effect names.

Returns
Returns a list which containing all the built-in audio effectsā€™ names.
See also
getAllBuiltinVideoFxNames

◆ getAllBuiltinCaptureAudioFxNames()

List<String> com.meicam.sdk.NvsStreamingContext.getAllBuiltinCaptureAudioFxNames ( )
inline

Gets the list of all built-in capture audio effect names.

Returns
Returns a list which containing all the built-in capture audio effectsā€™ names.
See also
getBeautyVideoFxName
getAllBuiltinVideoFxNames

◆ getAllBuiltinCaptureVideoFxNames()

List<String> com.meicam.sdk.NvsStreamingContext.getAllBuiltinCaptureVideoFxNames ( )
inline

Gets the list of all built-in capture video effectsā€™ names.

Returns
Returns a list which containing all built-in capture video effectsā€™ names.
See also
getBeautyVideoFxName
getAllBuiltinVideoFxNames

◆ getAllBuiltinVideoFxNames()

List<String> com.meicam.sdk.NvsStreamingContext.getAllBuiltinVideoFxNames ( )
inline

Gets the list of all built-in video effect names.

Returns
Returns a list which containing all the built-in video effectsā€™ names.
See also
getAllBuiltinAudioFxNames

◆ getAllBuiltinVideoTransitionNames()

List<String> com.meicam.sdk.NvsStreamingContext.getAllBuiltinVideoTransitionNames ( )
inline

Gets the list of all built-in video transitionsā€™ names.

Returns
Returns a list which containing all built-in video transitionsā€™ names.
See also
getAllBuiltinCaptureVideoFxNames
getBeautyVideoFxName
getDefaultVideoTransitionName

◆ getAssetPackageManager()

NvsAssetPackageManager com.meicam.sdk.NvsStreamingContext.getAssetPackageManager ( )
inline

Gets resource package manager.

Returns
Returns resource package manager object.

◆ getAudioFxDescription()

NvsFxDescription com.meicam.sdk.NvsStreamingContext.getAudioFxDescription ( String  fxName)
inline

Gets the description of an audio effect.

Parameters
fxNameAudio effectā€™s name
Returns
Returns the object of the audio effect description.
See also
getVideoFxDescription

◆ getAVFileInfo() [1/2]

NvsAVFileInfo com.meicam.sdk.NvsStreamingContext.getAVFileInfo ( String  avFilePath)
inline

Gets detailed information of the audio/video file.

Parameters
avFilePathFile path of the audio/video file
Returns
Returns the audio/video informationļ¼Œreturn null if file format is not supported

◆ getAVFileInfo() [2/2]

NvsAVFileInfo com.meicam.sdk.NvsStreamingContext.getAVFileInfo ( String  avFilePath,
int  extraFlag 
)
inline

Gets detailed information of the audio/video file.

Parameters
avFilePathFile path of the audio/video file
extraFlagGet extra information of the audio/video file. please refer to AV_FILEINFO_EXTRA
Returns
Returns the audio/video file information objectļ¼Œreturn null if file format is not supported

◆ getAVFileInfoWithError()

NvsAVFileInfo com.meicam.sdk.NvsStreamingContext.getAVFileInfoWithError ( String  avFilePath,
int  extraFlag,
StringBuilder  errorString 
)
inline

Gets detailed information of the audio/video file.

Parameters
avFilePathFile path of the audio/video file
extraFlagGet extra information of the audio/video file. please refer to AV_FILEINFO_EXTRA
errorStringOutput param for error description is valid if current function return null.
Returns
Returns the audio/video file information objectļ¼Œreturn null if file format is not supported
Since
2.20.0

◆ getAVInfoFromFile()

static NvsAVFileInfo com.meicam.sdk.NvsStreamingContext.getAVInfoFromFile ( String  avFilePath,
int  extraFlag 
)
inlinestatic

Gets detailed information of the audio/video file.

Parameters
avFilePathFile path of the audio/video file
extraFlagGet extra information of the audio/video file. please refer to AV_FILEINFO_EXTRA
Returns
Returns the audio/video informationļ¼Œreturn null if file format is not supported
Since
2.12.0

◆ getBeautyVideoFxName()

String com.meicam.sdk.NvsStreamingContext.getBeautyVideoFxName ( )
inline

Gets the name of beauty effect.

Returns
Returns the name of beauty effect.
See also
getAllBuiltinVideoFxNames
getAllBuiltinCaptureVideoFxNames

◆ getCaptureAnimatedStickerByIndex()

NvsCaptureAnimatedSticker com.meicam.sdk.NvsStreamingContext.getCaptureAnimatedStickerByIndex ( int  captureStikcerIndex)
inline

Gets a certain capture animated sticker.

Parameters
captureStikcerIndexaudio effect index
Returns
Returns the NvsCaptureAudioFx object.
See also
removeCaptureAnimatedSticker
Since
2.21.0

◆ getCaptureAnimatedStickerCount()

int com.meicam.sdk.NvsStreamingContext.getCaptureAnimatedStickerCount ( )
inline

Gets the count of capture animated sticker.

Returns
Returns the count of capture animated sticker.
Since
2.21.0

◆ getCaptureAudioFxByIndex()

NvsCaptureAudioFx com.meicam.sdk.NvsStreamingContext.getCaptureAudioFxByIndex ( int  captureAudioFxIndex)
inline

Gets a certain capture audio effect.

Parameters
captureVideoFxIndexaudio effect index
Returns
Returns the NvsCaptureAudioFx object.
See also
removeCaptureAudioFx
Since
2.18.0

◆ getCaptureAudioFxCount()

int com.meicam.sdk.NvsStreamingContext.getCaptureAudioFxCount ( )
inline

Gets the count of audio effects.

Returns
Returns the count of audio effects.
Since
2.18.0

◆ getCaptureCaptionByIndex()

NvsCaptureCaption com.meicam.sdk.NvsStreamingContext.getCaptureCaptionByIndex ( int  captureCaptionIndex)
inline

Gets a certain capture caption.

Parameters
captureCaptionIndexcaption index
Returns
Returns the NvsCaptureCaption object.
Since
2.21.0

◆ getCaptureCaptionCount()

int com.meicam.sdk.NvsStreamingContext.getCaptureCaptionCount ( )
inline

Gets the count of capture caption.

Returns
Returns the count of capture caption.
Since
2.21.0

◆ getCaptureCompoundCaptionByIndex()

NvsCaptureCompoundCaption com.meicam.sdk.NvsStreamingContext.getCaptureCompoundCaptionByIndex ( int  captureCaptionIndex)
inline

Gets a certain capture compound caption.

Parameters
captureCaptionIndexcompound caption index
Returns
Returns the NvsCaptureCompoundCaption object.
Since
2.21.0

◆ getCaptureCompoundCaptionCount()

int com.meicam.sdk.NvsStreamingContext.getCaptureCompoundCaptionCount ( )
inline

Gets the count of capture compound caption.

Returns
Returns the count of capture compound caption.
Since
2.21.0

◆ getCaptureDeviceCapability()

CaptureDeviceCapability com.meicam.sdk.NvsStreamingContext.getCaptureDeviceCapability ( int  captureDeviceIndex)
inline

Gets the capability description object of the capture device.

Parameters
captureDeviceIndexIndex of capturing device
Returns
Returns the NvsCaptureDeviceCapability object.

◆ getCaptureDeviceCount()

int com.meicam.sdk.NvsStreamingContext.getCaptureDeviceCount ( )
inline

Number of capture device.

Returns
Returns the number of capture device
See also
isCaptureDeviceBackFacing

◆ getCapturePreviewVideoSize()

NvsSize com.meicam.sdk.NvsStreamingContext.getCapturePreviewVideoSize ( int  captureDeviceIndex)
inline

Gets the capture preview resolution.

Parameters
captureDeviceIndexIndex of capturing device
Returns
Gets the capture preview resolution.
Since
1.7.1

◆ getCaptureVideoFxByIndex()

NvsCaptureVideoFx com.meicam.sdk.NvsStreamingContext.getCaptureVideoFxByIndex ( int  captureVideoFxIndex)
inline

Gets a certain capture video effect.

Parameters
captureVideoFxIndexVideo effect index
Returns
Returns the NvsCaptureVideoFx object.
See also
removeCaptureVideoFx

◆ getCaptureVideoFxCount()

int com.meicam.sdk.NvsStreamingContext.getCaptureVideoFxCount ( )
inline

Gets the count of video effects.

Returns
Returns the count of video effects.

◆ getColorGainForSDRToHDR()

float com.meicam.sdk.NvsStreamingContext.getColorGainForSDRToHDR ( )
inline

gets the color gain during SDR to HDR conversion.

Returns
Returns color gain. range is [1.0, 10.0]
Since
2.23.0
See also
setColorGainForSDRToHDR

◆ getCompileConfigurations()

Hashtable<String, Object> com.meicam.sdk.NvsStreamingContext.getCompileConfigurations ( )
inline

Gets configurations for compiling timeline.

Returns
Returns the configurations. If no configurations is set, ruturns a hashtable with no object. For key values in hashtable please refer to Configuration of compiling timeline.
See also
setCompileConfigurations

◆ getCompileVideoBitrateMultiplier()

float com.meicam.sdk.NvsStreamingContext.getCompileVideoBitrateMultiplier ( )
inline

Get the rate multiplier for compiling video.

Since
1.5.0
See also
setCompileVideoBitrateMultiplier

◆ getCurrentCaptureSceneId()

String com.meicam.sdk.NvsStreamingContext.getCurrentCaptureSceneId ( )
inline

Gets the ID of the current capture scene resource package.

Returns
Retruns the current ID of the capture scene resource package. nil indicates that there is no capture scene resource package for now.
Since
1.2.0
See also
applyCaptureScene
removeCurrentCaptureScene

◆ getCustomCompileVideoHeight()

int com.meicam.sdk.NvsStreamingContext.getCustomCompileVideoHeight ( )
inline

Gets the customized video height.

Returns
Returns the customized video height.
Since
1.6.1

◆ getDefaultThemeEndingLogoImageFilePath()

String com.meicam.sdk.NvsStreamingContext.getDefaultThemeEndingLogoImageFilePath ( )
inline

Gets the file path of the default ending logo.

Returns
Returns the file path of the default ending logo
See also
setDefaultThemeEndingLogoImageFilePath

◆ getDefaultVideoTransitionName()

String com.meicam.sdk.NvsStreamingContext.getDefaultVideoTransitionName ( )
inline

Gets the default video transitionā€™s name.

Returns
Returns a string representing the default transitionā€™s name.
See also
getAllBuiltinVideoTransitionNames

◆ getDeviceCpuLevel()

int com.meicam.sdk.NvsStreamingContext.getDeviceCpuLevel ( )
inline

Get Android camera device cpu power level.

Returns
cpu level, Please refer to device power level.
Since
3.8.0

◆ getDeviceGpuLevel()

int com.meicam.sdk.NvsStreamingContext.getDeviceGpuLevel ( )
inline

Get Android camera device gpu power level.

Returns
cpu level, Please refer to device power level.
Since
3.8.0

◆ getEngineHDRCaps()

int com.meicam.sdk.NvsStreamingContext.getEngineHDRCaps ( )
inline

Get HDR capability.

Returns
Returns a int value, Please refer to HDR capability flags.

◆ getExposureCompensation()

int com.meicam.sdk.NvsStreamingContext.getExposureCompensation ( )
inline

Gets exposure compensation.

Returns
Returns exposure compensation value
See also
setExposureCompensation

◆ getFlashMode()

int com.meicam.sdk.NvsStreamingContext.getFlashMode ( )
inline

get state of the flash light.

Returns
Returns flash mode value, please refer to Flash Mode
See also
toggleFlashMode

◆ getFontInfoByFilePath()

List<NvsFontInfo> com.meicam.sdk.NvsStreamingContext.getFontInfoByFilePath ( String  fontFilePath)
inline

Gets font file's font information.

Parameters
fontFilePathFont file path
Returns
Returns file's all font information

◆ getGLMaxTextureSize()

int com.meicam.sdk.NvsStreamingContext.getGLMaxTextureSize ( )
inline

Get GL max texture size.

Returns
max texture size of GL
Since
3.5.0

◆ getInstance()

static NvsStreamingContext com.meicam.sdk.NvsStreamingContext.getInstance ( )
inlinestatic

Gets the instance of streaming context object (only can use this after initialization)

Returns
Returns the streaming context object instance.
See also
init
close

◆ getInternalObject()

long com.meicam.sdk.NvsStreamingContext.getInternalObject ( )
inlineprotected

◆ getRecordVideoBitrateMultiplier()

float com.meicam.sdk.NvsStreamingContext.getRecordVideoBitrateMultiplier ( )
inline

Get the rate multiplier for recording video.

Since
1.5.0
See also
setRecordVideoBitrateMultiplier

◆ getSdkVersion()

SdkVersion com.meicam.sdk.NvsStreamingContext.getSdkVersion ( )
inline

Obtains Meishe SDK's version information.

Returns
Returns the object about Meishe SDK's version information.
Since
1.4.1

◆ getStreamingEngineState()

int com.meicam.sdk.NvsStreamingContext.getStreamingEngineState ( )
inline

Gets streaming engine's state.

Returns
Returns streaming engine's state. please refer to The flags of streaming engine state

◆ getTimelineCurrentPosition()

long com.meicam.sdk.NvsStreamingContext.getTimelineCurrentPosition ( NvsTimeline  timeline)
inline

Gets the current positon of the timeline (in microseconds)

Parameters
timelineTimeline
Returns
Returns the current position of the timeline
See also
seekTimeline

◆ getVideoFxDescription()

NvsFxDescription com.meicam.sdk.NvsStreamingContext.getVideoFxDescription ( String  fxName)
inline

Gets the description of a video effect.

Parameters
fxNameVideo effectā€™s name
Returns
Returns the object of the video effect description.
See also
getAudioFxDescription

◆ getVideoStabilization()

int com.meicam.sdk.NvsStreamingContext.getVideoStabilization ( )
inline

Gets the current videoā€™s stabilization flag.

Returns
Returns the current flag.Please refer to Flag of stabilization.
See also
setVideoStabilization

◆ getZoom()

int com.meicam.sdk.NvsStreamingContext.getZoom ( )
inline

Gets the zoom factor.

Returns
Returns zoom factor value.
See also
setZoom

◆ grabImageFromTimeline() [1/2]

Bitmap com.meicam.sdk.NvsStreamingContext.grabImageFromTimeline ( NvsTimeline  timeline,
long  timestamp,
NvsRational  proxyScale 
)
inline

Gets the specific frame in timeline with a specific timestamp. For details please refer to The video frame retriever .

Parameters
timelineThe timeline that will be grabbed from.
timestampThe desired frame's timestamp(in microseconds). Timestamp should be within range [0,timeline.duration - 1]. Other inputs are invalid and will results grabImageFromTimeline returns null.
proxyScaleZoom scale of proxy
Returns
Returns the frame's Bitmap object which the timestamp corresponding to, returns null if grabbing frame failed.
Since
1.1.2

◆ grabImageFromTimeline() [2/2]

Bitmap com.meicam.sdk.NvsStreamingContext.grabImageFromTimeline ( NvsTimeline  timeline,
long  timestamp,
NvsRational  proxyScale,
int  flags 
)
inline

Gets the specific frame in timeline with a specific timestamp. For details please refer to The video frame retriever.

Parameters
timelineThe timeline that will be grabbed from.
timestampThe desired frame's timestamp(in microseconds). Timestamp should be within range [0,timeline.duration - 1]. Other inputs are invalid and will results grabImageFromTimeline returns null.
proxyScaleZoom scale of proxy
flagsFlags for streaming engine seeking. For specific please refer to The seek flag of streaming engine.
Returns
Returns the frame's Bitmap object the timestamp corresponding to, returns null if grabbing frame failed.
Since
1.16.0

◆ grabImageFromTimelineAsync()

boolean com.meicam.sdk.NvsStreamingContext.grabImageFromTimelineAsync ( NvsTimeline  timeline,
long  timestamp,
NvsRational  proxyScale,
int  flags 
)
inline

Gets the specific frame in timeline with a specific timestamp. For details please refer to The video frame retriever. This function is an internal asynchronous call. It is necessary to ensure that SeekTimeline () will not be invoked before getting the image. If the function that calls SeekTimeline after calling this function may not get the callback of the image, it can call Stop after this function to ensure that the Grab image can be executed successfully.

Parameters
timelineThe timeline that will be grabbed from.
timestampThe desired frame's timestamp(in microseconds). Timestamp should be within range [0,timeline.duration - 1]. Other inputs are invalid and will results grabImageFromTimeline returns null.
proxyScaleZoom scale of proxy
flagsFlags for streaming engine seeking. For specific please refer to The seek flag of streaming engine.
Returns
Returns a boolean value.
Since
2.14.0

◆ hasARModule()

static int com.meicam.sdk.NvsStreamingContext.hasARModule ( )
inlinestatic

Checks if current SDK has an AR module.

Returns
Return value tells whether it has an AR module.
Since
2.5.0

◆ init() [1/3]

static NvsStreamingContext com.meicam.sdk.NvsStreamingContext.init ( Activity  mainActivity,
String  sdkLicenseFilePath 
)
inlinestatic

Initializes an instance of streaming context object.

Parameters
mainActivityMain activity object from android.
sdkLicenseFilePathSpecified SDK license file path.
Returns
Returns the streaming context instance object.
See also
getInstance
close

◆ init() [2/3]

static NvsStreamingContext com.meicam.sdk.NvsStreamingContext.init ( Activity  mainActivity,
String  sdkLicenseFilePath,
int  flags 
)
inlinestatic

Initializes the instance of streaming context object. for more please refer to (4k video editing).

Parameters
mainActivityMain activity object from android.
sdkLicenseFilePathSpecified SDK license file path.
flagsFlags filed, 0 if no special demand, please refer to [STREAMING_CONTEXT_FLAG].
Returns
Returns a streaming context instance object.
Since
1.5.0
See also
getInstance
close

◆ init() [3/3]

static NvsStreamingContext com.meicam.sdk.NvsStreamingContext.init ( Context  ctx,
String  sdkLicenseFilePath,
int  flags 
)
inlinestatic

Initializes streaming context instance.

Parameters
ctxAndroid context object.
sdkLicenseFilePathSpecified SDK license file path.
flagsFlags, 0 if no special requirement, please refer to (STREAMING_CONTEXT_FLAG).
Returns
Returns a streaming context instance object.
Since
2.0.1
See also
getInstance
close

◆ initHumanDetection()

static boolean com.meicam.sdk.NvsStreamingContext.initHumanDetection ( Context  ctx,
String  modelFilePath,
String  licenseFilePath,
int  features 
)
inlinestatic

Initializes human detection. Only once needed.

Parameters
ctxThe context object from android.
modelFilePathThe path of modle file.
licenseFilePathThe path of authorization file.
featuresHuman detection features field, please refer to Human detection features.
Returns
Returns a value representing if it succeeded.
See also
closeHumanDetection
Since
2.5.0

◆ initHumanDetectionExt()

static boolean com.meicam.sdk.NvsStreamingContext.initHumanDetectionExt ( Context  ctx,
String  modelFilePath,
String  licenseFilePath,
int  features 
)
inlinestatic

Human detection initialization extension. Must be called after calling initHumanDetection.

Parameters
ctxThe context object from android.
modelFilePathThe path of extra modle file.
licenseFilePathThe path of authorization file.
featuresHuman detection features field, please refer to Human detection features.
Returns
Returns a value representing if it succeeded.
See also
closeHumanDetection
Since
2.5.0

◆ insertBeautyCaptureVideoFx()

NvsCaptureVideoFx com.meicam.sdk.NvsStreamingContext.insertBeautyCaptureVideoFx ( int  insertPosition)
inline

Inserts a skin beauty video effect.

Parameters
insertPositionInsertion position
Returns
Returns the inserted NvsCaptureVideoFx object.
See also
appendBeautyCaptureVideoFx

◆ insertBuiltinCaptureAudioFx()

NvsCaptureAudioFx com.meicam.sdk.NvsStreamingContext.insertBuiltinCaptureAudioFx ( String  audioFxName,
int  insertPosition 
)
inline

Inserts a built-in audio capture effect.

Parameters
audioFxNameaudio effect name. To get the audio effect name, please refer to getAllBuiltinCaptureAudioFxNames() or The List of Built-in Effect Name.
insertPositionInsertion position.
Returns
Returns the inserted NvsCaptureVideoFx object.
See also
appendBuiltinCaptureAudioFx
Since
2.18.0

◆ insertBuiltinCaptureVideoFx()

NvsCaptureVideoFx com.meicam.sdk.NvsStreamingContext.insertBuiltinCaptureVideoFx ( String  videoFxName,
int  insertPosition 
)
inline

Inserts a built-in video capture effect.

Parameters
videoFxNameVideo effect name. To get the video effect name, please refer to getAllBuiltinCaptureVideoFxNames() or The List of Built-in Effect Name.
insertPositionInsertion position.
Returns
Returns the inserted NvsCaptureVideoFx object.
See also
appendBuiltinCaptureVideoFx

◆ insertCaptureAnimatedSticker()

NvsCaptureAnimatedSticker com.meicam.sdk.NvsStreamingContext.insertCaptureAnimatedSticker ( long  offsetTime,
long  duration,
String  animatedStickerPackageId,
int  insertPosition 
)
inline

Appends a animated sticker.

Parameters
offsetTimeanimated sticker's offset time.
durationanimated sticker's duration.
animatedStickerPackageIdAnimated sticker package Id.
insertPositionInsertion position.
Returns
Returns the appended NvsCaptureAnimatedSticker object.
It will return null in the following situations:
1. No animated sticker function authorization;
2. The animatedStickerPackageId is empty or null;
3. The animatedSticker has not install successed;
See also
appendCaptureAnimatedSticker
Since
2.21.0

◆ insertCaptureCaption()

NvsCaptureCaption com.meicam.sdk.NvsStreamingContext.insertCaptureCaption ( String  captionText,
long  offsetTime,
long  duration,
String  captionStylePackageId,
int  insertPosition 
)
inline

Insert a caption.

Parameters
captionTextText of caption
offsetTimecatpion's offset time.
durationcatpion's duration.
captionStylePackageIdCaption style package Id.If it does not exist, you can pass an empty string or null.
insertPositionInsertion position.
Returns
Returns the appended NvsCaptureCompoundCaption object.
It will return null in the following situations:
1. No caption function authorization;
See also
appendCaptureCompoundCaption
Since
2.21.0

◆ insertCaptureCompoundCaption()

NvsCaptureCompoundCaption com.meicam.sdk.NvsStreamingContext.insertCaptureCompoundCaption ( long  offsetTime,
long  duration,
String  compoundCaptionPackageId,
int  insertPosition 
)
inline

Insert a compound caption.

Parameters
offsetTimecompound catpion's offset time.
durationcompound catpion's duration.
compoundCaptionPackageIdCaption style package Id.If it does not exist, you can pass an empty string or null.
insertPositionInsertion position.
Returns
Returns the appended NvsCaptureCompoundCaption object.
It will return null in the following situations:
1. No compound caption function authorization;
See also
appendCaptureCompoundCaption
Since
2.21.0

◆ insertCaptureModularCaption()

NvsCaptureCaption com.meicam.sdk.NvsStreamingContext.insertCaptureModularCaption ( String  captionText,
long  offsetTime,
long  duration,
int  insertPosition 
)
inline

Insert a modular caption.

Parameters
captionTextText of caption
offsetTimecatpion's offset time.
durationcatpion's duration.
insertPositionInsertion position.
Returns
Returns the appended NvsCaptureCompoundCaption object.
It will return null in the following situations:
1. No caption function authorization;
See also
appendCaptureCompoundCaption
Since
2.21.0

◆ insertCustomCaptureAnimatedSticker()

NvsCaptureAnimatedSticker com.meicam.sdk.NvsStreamingContext.insertCustomCaptureAnimatedSticker ( long  offsetTime,
long  duration,
String  animatedStickerPackageId,
String  customImagePath,
int  insertPosition 
)
inline

Insert a animated sticker.

Parameters
offsetTimeanimated sticker's offset time.
durationanimated sticker's duration.
animatedStickerPackageIdAnimated sticker package Id.
customImagePathPath of custom animated sticker image(It can be a jpg, png image, or a dynamic caf format image supported by Meishe sdk)
insertPositionInsertion position.
Returns
Returns the appended NvsCaptureAnimatedSticker object.
It will return null in the following situations:
1. No animated sticker function authorization;
2. The animatedStickerPackageId is empty or null;
3. The animatedSticker has not install successed;
See also
appendCaptureAnimatedSticker
Since
3.2.0

◆ insertCustomCaptureVideoFx()

NvsCaptureVideoFx com.meicam.sdk.NvsStreamingContext.insertCustomCaptureVideoFx ( NvsCustomVideoFx.Renderer  customVideoFxRender,
int  insertPosition 
)
inline

Inserts a custom capture video effect.

Parameters
customVideoFxRenderInterface of user-implemented custom video effect renderer
insertPositionInsertion position
Returns
Returns the inserted NvsCaptureVideoFx object.
Warning
This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.
Since
1.7.0

◆ insertPackagedCaptureVideoFx()

NvsCaptureVideoFx com.meicam.sdk.NvsStreamingContext.insertPackagedCaptureVideoFx ( String  videoFxPackageId,
int  insertPosition 
)
inline

Inserts a package capture effect.

Parameters
videoFxPackageIdVideo effect package ID
insertPositionInsertion position
Returns
Returns the inserted NvsCaptureVideoFx object.
See also
appendPackagedCaptureVideoFx

◆ isAndroidCameraPreferDualBufferAR()

boolean com.meicam.sdk.NvsStreamingContext.isAndroidCameraPreferDualBufferAR ( )
inline

Get Android camera device tend to use dual buffer model to render AR.

Since
3.6.0
Returns
Whether it is a pure black picture
Since
3.6.0

◆ isAuxiliaryContext()

boolean com.meicam.sdk.NvsStreamingContext.isAuxiliaryContext ( )
inlineprotected

◆ isBlackFrame()

boolean com.meicam.sdk.NvsStreamingContext.isBlackFrame ( Bitmap  bitmap)
inline

Determining whether the incoming bitmap is a black image, and judging by the mean value and variance of the image pixels.

Parameters
bitmap.The bitmap you need
Since
2.21.1
Returns
Whether it is a pure black picture
Since
2.21.1

◆ isCaptureDeviceBackFacing()

boolean com.meicam.sdk.NvsStreamingContext.isCaptureDeviceBackFacing ( int  captureDeviceIndex)
inline

Whether it's a rear capturing device.

Parameters
captureDeviceIndexIndex of capturing device
Returns
Returns boolean value. YES means it is a rear capture device, and NO means the opposite.

◆ isCompilingPaused()

boolean com.meicam.sdk.NvsStreamingContext.isCompilingPaused ( )
inline

Check if compiling timeline is paused.

Returns
Returns a boolean value indicating whether compiling timeline is paused
Since
2.9.0
See also
pauseCompiling

◆ isDefaultCaptionFade()

boolean com.meicam.sdk.NvsStreamingContext.isDefaultCaptionFade ( )
inline

gets whether default caption mode is fade in and fade out.

Returns
Returns whether is fade in and fade out.
Since
1.8.0
See also
setDefaultCaptionFade

◆ isFlashOn()

boolean com.meicam.sdk.NvsStreamingContext.isFlashOn ( )
inline

get state of the flash light.

Returns
Returns a boolean value, true means flash light is on and false means off.
See also
toggleFlash

◆ isPlaybackPaused()

boolean com.meicam.sdk.NvsStreamingContext.isPlaybackPaused ( )
inline

Check if playback timeline is paused.

Returns
Returns a boolean value indicating whether compiling timeline is paused
Since
2.9.0
See also
pauseCompiling

◆ isRecordingPaused()

boolean com.meicam.sdk.NvsStreamingContext.isRecordingPaused ( )
inline

Checks if the recording has been paused.

Returns
Returns a boolean value. If the value is YES, the recording has been paused, and NO means it's not paused.
Since
1.17.0
See also
pauseRecording
resumeRecording

◆ isSdkAuthorised()

boolean com.meicam.sdk.NvsStreamingContext.isSdkAuthorised ( )
inline

Checks if sdk is authorized.

◆ loadProject()

NvsTimeline com.meicam.sdk.NvsStreamingContext.loadProject ( String  projectId,
String  resourceDir,
int  flags 
)
inline

Load project.

Parameters
projectIdproject uuidļ¼Œproject must be installed firstly
resourceDirresource dir of the project asset
flagsSpecial flags for create timeline. If there is no special requirements please input 0. Please refer to create timeline flag.
Returns
Returns created timeline object
Since
3.4.3
See also
removeTimeline

◆ openMainThreadChecker()

static void com.meicam.sdk.NvsStreamingContext.openMainThreadChecker ( boolean  enable)
inlinestatic

Open main thread checker or not.

Parameters
flagchecker switch.

◆ pauseCompiling()

boolean com.meicam.sdk.NvsStreamingContext.pauseCompiling ( )
inline

Pause compiling timeline.

Returns
Returns a boolean value indicating whether the pause was successful
Since
2.9.0
See also
resumeCompiling

◆ pausePlayback()

boolean com.meicam.sdk.NvsStreamingContext.pausePlayback ( )
inline

Pause playback timeline.

Returns
Returns a boolean value indicating whether the pause was successful
Since
2.14.0
See also
resumeCompiling

◆ pauseRecording()

boolean com.meicam.sdk.NvsStreamingContext.pauseRecording ( )
inline

Pause to record. Resuming recording after a pause will output the recorded video to the same file. Note: Recording can only be paused without using the built-in recorder!

Returns
Returns a boolean value. A value of YES pause to record successfully and NO means it fails to pause.
Since
1.17.0
See also
resumeRecording

◆ playbackTimeline() [1/2]

boolean com.meicam.sdk.NvsStreamingContext.playbackTimeline ( NvsTimeline  timeline,
long  startTime,
long  endTime,
int  videoSizeMode,
boolean  preload,
int  flags 
)
inline

Timeline playback.

Parameters
timelineTimeline
startTimeStart time(in microseconds). Start time should be in the range [0,timeline.duration - 1], other inputs are invalid and playbackTimeline will return false resulting playback cannot be turned on.
endTimeEnd time(in microseconds). If endtime input is a negative value, then the playback is defaultly set to play till the end.
videoSizeModeIf no special requirements please input 0. Please refer to The video preview sizemode for reference.
preloadWhether to preload
flagsFlags for preview. If no special requirements please input 0. Please refer to The Streaming engine playback flags for reference.
Returns
Returns a boolean value. Note: timeline playback is an asynchronous operation, it returns true if timeline playback can be turned on.
Warning
This interface will trigger streaming engine to jump to stop state. For detailed situations please refer to The engine change.
See also
seekTimeline
compileTimeline

◆ playbackTimeline() [2/2]

boolean com.meicam.sdk.NvsStreamingContext.playbackTimeline ( NvsTimeline  timeline,
long  startTime,
long  endTime,
NvsRational  proxyScale,
boolean  preload,
int  flags 
)
inline

Timeline playback.

Parameters
timelineTimeline
startTimeStart time(in microseconds). Start time should be in the range [0,timeline.duration - 1], other inputs are invalid and playbackTimeline will return false resulting playback cannot be turned on.
endTimeEnd time(in microseconds). If endtime input is a negative value, then the playback is defaultly set to play till the end.
proxyScaleZoom scale of proxy
preloadWhether to preload
flagsFlags for preview. If no special requirements please input 0. Please refer to The Streaming engine playback flags
Returns
Returns a boolean value. Note: timeline playback is an asynchronous operation, it returns true if timeline playback can be turned on.
Warning
This interface will trigger streaming engine to jump to stop state. For detailed situations please refer to The engine change.
See also
seekTimeline
compileTimeline

◆ preloadEffectResources()

boolean com.meicam.sdk.NvsStreamingContext.preloadEffectResources ( )
inline

Preload effect resources.

Since
2.18.1

◆ registerFontByFilePath()

String com.meicam.sdk.NvsStreamingContext.registerFontByFilePath ( String  fontFilePath)
inline

Gets font file's fontFamily.

Parameters
fontFilePathFont file path
Returns
Returns font file's fontFamily information

◆ removeAllCaptureAnimatedSticker()

void com.meicam.sdk.NvsStreamingContext.removeAllCaptureAnimatedSticker ( )
inline

Removes all capture animated sticker.

See also
removeCaptureAnimatedSticker
getCaptureAnimatedStickerCount
Since
2.21.0

◆ removeAllCaptureAudioFx()

void com.meicam.sdk.NvsStreamingContext.removeAllCaptureAudioFx ( )
inline

Removes all capture audio effects.

See also
removeCaptureAudioFx
getCaptureAudioFxCount
Since
2.18.0

◆ removeAllCaptureCaption()

void com.meicam.sdk.NvsStreamingContext.removeAllCaptureCaption ( )
inline

Removes all capture caption.

Since
2.21.0

◆ removeAllCaptureCompoundCaption()

void com.meicam.sdk.NvsStreamingContext.removeAllCaptureCompoundCaption ( )
inline

Removes all capture compound caption.

Since
2.21.0

◆ removeAllCaptureVideoFx()

void com.meicam.sdk.NvsStreamingContext.removeAllCaptureVideoFx ( )
inline

Removes all capture video effects.

See also
removeCaptureVideoFx
getCaptureVideoFxCount

◆ removeCaptureAnimatedSticker()

boolean com.meicam.sdk.NvsStreamingContext.removeCaptureAnimatedSticker ( int  captureAnimagedStickerIndex)
inline

Removes a certain capture animated sticker indicated by its index.

Parameters
captureAnimagedStickerIndexanimated sticker index
Returns
Returns a boolean value. If it is YES, the removal is successful, and NO means failure.
See also
appendCaptureAnimatedSticker
Since
2.21.0

◆ removeCaptureAudioFx()

boolean com.meicam.sdk.NvsStreamingContext.removeCaptureAudioFx ( int  captureAudioFxIndex)
inline

Removes a certain capture audio effect indicated by its index.

Parameters
captureAudioFxIndexaudio effect index
Returns
Returns a boolean value. If it is YES, the removal is successful, and NO means failure.
See also
appendBuiltinCaptureAudioFx
Since
2.18.0

◆ removeCaptureCaption()

boolean com.meicam.sdk.NvsStreamingContext.removeCaptureCaption ( int  captureCaptionIndex)
inline

Removes a certain capture caption indicated by its index.

Parameters
captureCaptionIndexcaption index
Returns
Returns a boolean value. If it is YES, the removal is successful, and NO means failure.
Since
2.21.0

◆ removeCaptureCompoundCaption()

boolean com.meicam.sdk.NvsStreamingContext.removeCaptureCompoundCaption ( int  captureCompoundCaptionIndex)
inline

Removes a certain capture compound caption indicated by its index.

Parameters
captureCompoundCaptionIndexcompound caption index
Returns
Returns a boolean value. If it is YES, the removal is successful, and NO means failure.
Since
2.21.0

◆ removeCaptureVideoFx()

boolean com.meicam.sdk.NvsStreamingContext.removeCaptureVideoFx ( int  captureVideoFxIndex)
inline

Removes a certain capture video effect indicated by its index.

Parameters
captureVideoFxIndexVideo effect index
Returns
Returns a boolean value. If it is YES, the removal is successful, and NO means failure.
See also
appendBuiltinCaptureVideoFx
appendPackagedCaptureVideoFx
appendBeautyCaptureVideoFx

◆ removeCurrentCaptureScene()

void com.meicam.sdk.NvsStreamingContext.removeCurrentCaptureScene ( )
inline

Removes the current capture scene.

Since
1.2.0
See also
applyCaptureScene
getCurrentCaptureSceneId

◆ removeTimeline()

boolean com.meicam.sdk.NvsStreamingContext.removeTimeline ( NvsTimeline  timeline)
inline

Removes timeline.

Parameters
timelineThe timeline to be removed
Returns
Returns a boolean value. true means a successful remove, false means failure.
Warning
This interface will trigger streaming engine to jump to stop state. For detailed situations please refer to The engine change.
See also
createTimeline

◆ removeUserWatermarkForCapture()

void com.meicam.sdk.NvsStreamingContext.removeUserWatermarkForCapture ( )
inline

Removes custom watermark which added for capturing video.

Since
2.0.1

◆ resumeCompiling()

boolean com.meicam.sdk.NvsStreamingContext.resumeCompiling ( )
inline

Resume compiling timeline.

Returns
Returns a boolean value indicating whether the resume was successful
Since
2.9.0
See also
pauseCompiling

◆ resumePlayback()

boolean com.meicam.sdk.NvsStreamingContext.resumePlayback ( )
inline

Resume playback timeline.

Returns
Returns a boolean value indicating whether the resume was successful
Since
2.14.0
See also
pausePlayback

◆ resumeRecording()

boolean com.meicam.sdk.NvsStreamingContext.resumeRecording ( )
inline

Continues to record. Continuing recording will output the recorded video to the same media file, to which the recording before suspend outputs contents.

Returns
Returns a boolean value. A value of YES means it continues recording successfully and NO means it fails to continue.
Since
1.17.0
See also
pauseRecording

◆ sampleColorFromCapturedVideoFrame()

NvsColor com.meicam.sdk.NvsStreamingContext.sampleColorFromCapturedVideoFrame ( RectF  sampleRect)
inline

Samples the capture device's video frame.

Parameters
sampleRectRectangular area to sample, of which coordinates are in livewindow's coordinate system
Returns
Returns the NvsColor object. This color value is the average color value of all pixels in sampled rectangular area.
Since
1.2.0

◆ seekTimeline() [1/2]

boolean com.meicam.sdk.NvsStreamingContext.seekTimeline ( NvsTimeline  timeline,
long  timestamp,
int  videoSizeMode,
int  flags 
)
inline

Seeking the frame at a specific timestamp.

Parameters
timelineTimeline
timestampTimestamp (in microseconds). Timestamp should be in the range of [0,timeline.duration - 1]. Other input values are invalid and seekTimeline will return false, results can't targeting.
videoSizeModeVideo preview mode. Please refer to video preview sizemode
flagsFlags for streaming engine seeking. For specific please refer to seeking flags of streaming engine
Returns
Returns a boolean value. Note: Seek to a specific timestamp is an asynchronous operation, it returns true which means seeking successful, false means seeking failure.
Warning
This interface will trigger streaming engine to jump to stop state. For detailed situations please refer to The changes of engine.
See also
playbackTimeline
compileTimeline

◆ seekTimeline() [2/2]

boolean com.meicam.sdk.NvsStreamingContext.seekTimeline ( NvsTimeline  timeline,
long  timestamp,
NvsRational  proxyScale,
int  flags 
)
inline

Seeking the frame at a specific timestamp.

Parameters
timelineTimeline
timestampTimestamp(in microseconds). Timestamp should be in the range of [0,timeline.duration - 1]. Other input values are invalid and seeking timeline will return false, results seeking cannot be turned on.
proxyScaleZoom scale of proxy
flagsFlags for streaming engine seeking. For specific please refer toseeking flags of streaming engine
Returns
Returns a boolean value. Note: Seeking to a specific timestamp is an asynchronous operation, it returns true is refer seeking is successfully turned on, false means seeking cannot be turned on.
Warning
This interface will trigger streaming engine to jump to stop state. For detailed situations please refer to The engine change.
See also
playbackTimeline
compileTimeline

◆ sendBufferToCapturePreview() [1/2]

boolean com.meicam.sdk.NvsStreamingContext.sendBufferToCapturePreview ( byte[]  data,
long  streamTime 
)
inline

Transfers the input buffer to capture preivew.

Parameters
dataThe byte array to send to buffer, only NV21 is supported.
streamTimeTimestamp of the input buffer
Returns
Returns boolean value.
See also
startBufferCapturePreview

◆ sendBufferToCapturePreview() [2/2]

boolean com.meicam.sdk.NvsStreamingContext.sendBufferToCapturePreview ( byte[]  data,
long  streamTime,
int  flags 
)
inline

Sends buffer to the capture preview.

Parameters
dataThe byte array to send to buffer, only NV21 is supported.
streamTimeTimestamp of the input buffer
flagsflag value
Returns
Returns boolean value.
See also
startBufferCapturePreview

◆ setAudioOutputCallback()

void com.meicam.sdk.NvsStreamingContext.setAudioOutputCallback ( AudioOutputCallback  cb)
inline

Sets callback interface of audio output.

Parameters
cbCallback interface for audio output
Since
2.20.0

◆ setAudioOutputDeviceVolume()

void com.meicam.sdk.NvsStreamingContext.setAudioOutputDeviceVolume ( float  volume)
inline

set volume to audio output device.

Parameters
volumenew volume to device, value range[0, 1]
Since
2.14.0

◆ setAudioSampleInfoForCallback()

void com.meicam.sdk.NvsStreamingContext.setAudioSampleInfoForCallback ( NvsCapturedAudioSampleInfo  info)
inline

Set audio sample information for callback of capturing.

Parameters
infoaudio sample information

◆ setAutoExposureRect()

void com.meicam.sdk.NvsStreamingContext.setAutoExposureRect ( RectF  exposureRect)
inline

Set the auto exposure detection area.

Parameters
exposureRectAutomatic exposure detection area, the coordinates are the real-time preview window's own coordinate system.
Since
1.15.1

◆ setCapturedAudioCallback()

void com.meicam.sdk.NvsStreamingContext.setCapturedAudioCallback ( CapturedAudioCallback  cb)
inline

Sets callback interface of audio output.

Parameters
cbCallback interface for audio output
Since
3.0.3

◆ setCaptureDeviceCallback()

void com.meicam.sdk.NvsStreamingContext.setCaptureDeviceCallback ( CaptureDeviceCallback  cb)
inline

Sets callback interface for capturing device.

Parameters
cbCallback interface for capturing device.

◆ setCapturedPictureCallback()

void com.meicam.sdk.NvsStreamingContext.setCapturedPictureCallback ( CapturedPictureCallback  cb)
inline

Sets callback interface for getting capture preview frame.

Parameters
cbCallback interface for getting capture preview frame

◆ setCapturedVideoFrameGrabberCallback()

void com.meicam.sdk.NvsStreamingContext.setCapturedVideoFrameGrabberCallback ( CapturedVideoFrameGrabberCallback  cb)
inline

Sets callback interface for getting capture preview frame.

Parameters
cbCallback interface for getting capture preview frame

◆ setCaptureRecordingDurationCallback()

void com.meicam.sdk.NvsStreamingContext.setCaptureRecordingDurationCallback ( CaptureRecordingDurationCallback  cb)
inline

Sets callback interface of recording duration.

Parameters
cbCallback interface for recording duration
Since
2.11.0

◆ setCaptureRecordingFrameReachedCallback()

void com.meicam.sdk.NvsStreamingContext.setCaptureRecordingFrameReachedCallback ( CaptureRecordingFrameReachedCallback  cb)
inline

Sets callback interface for recording frame reached.

Parameters
cbCallback interface for recording frame reached

◆ setCaptureRecordingStartedCallback()

void com.meicam.sdk.NvsStreamingContext.setCaptureRecordingStartedCallback ( CaptureRecordingStartedCallback  cb)
inline

Sets callback interface for recording started.

Parameters
cbCallback interface for recording started

◆ setColorGainForSDRToHDR()

void com.meicam.sdk.NvsStreamingContext.setColorGainForSDRToHDR ( float  gain)
inline

Sets the color gain during SDR to HDR conversion.

Parameters
gaincolor gain. range is [1.0, 10.0]
Since
2.23.0
See also
getColorGainForSDRToHDR

◆ setCompileCallback()

void com.meicam.sdk.NvsStreamingContext.setCompileCallback ( CompileCallback  cb)
inline

Sets callback interface for timeline file compilation.

Parameters
cbCallback interface for timeline file compilation

◆ setCompileCallback2()

void com.meicam.sdk.NvsStreamingContext.setCompileCallback2 ( CompileCallback2  cb)
inline

Sets the second callback interface for timeline file compilation.

Parameters
cbThe second callback socket for timeline file compilation
Since
1.6.0

◆ setCompileCallback3()

void com.meicam.sdk.NvsStreamingContext.setCompileCallback3 ( CompileCallback3  cb)
inline

Sets the third callback interface for timeline file compilation.

Parameters
cbThe second callback socket for timeline file compilation
Since
2.21.1

◆ setCompileConfigurations()

void com.meicam.sdk.NvsStreamingContext.setCompileConfigurations ( Hashtable< String, Object >  compileConfigurations)
inline

Sets the timeline configurations, which stay valid once set.

Parameters
compileConfigurationsCompile timeline configurations. For key values in Hashtable please refer to Configuration of compiling timeline.for exampleļ¼š
        Hashtable<String, Object> config = new Hashtable<>();
        config.put(NvsStreamingContext.COMPILE_GOP_SIZE, 15); //If set to 1 then a I-frame-only video is compiled. (Note: some android phones cannot compile I-frame-only video. In this case,please use STREAMING_ENGINE_COMPILE_FLAG_DISABLE_HARDWARE_ENCODER to encode)
        config.put(NvsStreamingContext.COMPILE_BITRATE, 10000000); // 10M bps
        config.put(NvsStreamingContext.COMPILE_AUDIO_BITRATE, 320000); //  Sets audio bitrate to 320Kbps.
        config.put(NvsStreamingContext.COMPILE_LOSSLESS_AUDIO, true); // Sets audio to lossless.
        config.put(NvsStreamingContext.COMPILE_OPTIMIZE_FOR_NETWORK_USE, true); // Sets index table to prepose.
        config.put(NvsStreamingContext.COMPILE_USE_OPERATING_RATE, true); // using operating rate
        config.put(NvsStreamingContext.COMPILE_FPS, new NvsRational(30, 1)); // using a customized fps
        m_streamingContext.setCompileConfigurations(config);

Cancels configurations and returns to default settings:

         config.put(NvsStreamingContext.COMPILE_GOP_SIZE, null);
Since
1.8.0
See also
getCompileConfigurations

◆ setCompileFloatProgressCallback()

void com.meicam.sdk.NvsStreamingContext.setCompileFloatProgressCallback ( CompileFloatProgressCallback  cb)
inline

◆ setCompileVideoBitrateMultiplier()

void com.meicam.sdk.NvsStreamingContext.setCompileVideoBitrateMultiplier ( float  compileVideoBitrateMultiplier)
inline

Set the rate multiplier for compiling video.

Parameters
compileVideoBitrateMultiplierMultiplier
Since
1.5.0
See also
getCompileVideoBitrateMultiplier

◆ setCustomCompileVideoHeight()

void com.meicam.sdk.NvsStreamingContext.setCustomCompileVideoHeight ( int  videoHeight)
inline

Sets the customized height for video.

   When compiling videos, set the bitrate grade for compiled video to COMPILE_VIDEO_RESOLUTION_GRADE_CUSTOM.
   Plesae note, to make sure the file is compiled successfully, Meishe SDK would calibrate the height accordingly,
   thus the final output file may not necessarily be the height set here.
Parameters
videoHeightCustomized height value of the compiled video.
Since
1.6.1
See also
compileTimeline

◆ setDefaultAudioTransitionName()

void com.meicam.sdk.NvsStreamingContext.setDefaultAudioTransitionName ( String  audioTransitionName)
inline

Sets the default audio transitionā€™s name.

Parameters
audioTransitionNameaudio transitionā€™s name
See also
getAllBuiltinVideoTransitionNames

◆ setDefaultCaptionFade()

void com.meicam.sdk.NvsStreamingContext.setDefaultCaptionFade ( boolean  fade)
inline

Sets whether default caption mode is fade in and fade out.

Parameters
fadewhether is fade in and fade out.
Since
1.8.0
See also
isDefaultCaptionFade

◆ SetDefaultImageClipDuration()

void com.meicam.sdk.NvsStreamingContext.SetDefaultImageClipDuration ( long  defaultImageClipDuration)
inline

Sets the default image clip duration.

Parameters
bitmap.image clip duration
Since
3.4.0
Returns
Whether it is a pure black picture
Since
3.4.0

◆ setDefaultThemeEndingLogoImageFilePath()

boolean com.meicam.sdk.NvsStreamingContext.setDefaultThemeEndingLogoImageFilePath ( String  logoImageFilePath)
inline

Sets default theme's ending logo.

Parameters
logoImageFilePathFile path of the ending logo image
Returns
Returns whether setting the logo is successful. True means success, false means failure
See also
getDefaultThemeEndingLogoImageFilePath

◆ setExposureCompensation()

void com.meicam.sdk.NvsStreamingContext.setExposureCompensation ( int  exposureCompensation)
inline

Set exposure compensation.

Parameters
exposureCompensationExposure compensation value
See also
getExposureCompensation
getCaptureDeviceCapability

◆ setHardwareErrorCallback()

void com.meicam.sdk.NvsStreamingContext.setHardwareErrorCallback ( HardwareErrorCallback  cb)
inline

Sets callback interface for hardware error.

Parameters
cbCallback interface for hardware error
Since
1.16.0

◆ setImageGrabberCallback()

void com.meicam.sdk.NvsStreamingContext.setImageGrabberCallback ( ImageGrabberCallback  callback)
inline

Sets callback interface for timeline image grabber.

Parameters
cbCallback interface for timeline image grabber

◆ setImageGrabberCallback2()

void com.meicam.sdk.NvsStreamingContext.setImageGrabberCallback2 ( ImageGrabberCallback2  callback)
inline

Sets second callback interface for timeline image grabber.

Parameters
cbThe second callback interface for timeline image grabber

◆ setInternalObject()

void com.meicam.sdk.NvsStreamingContext.setInternalObject ( long  internalObject)
inlineprotected

◆ setPlaybackCallback()

void com.meicam.sdk.NvsStreamingContext.setPlaybackCallback ( PlaybackCallback  cb)
inline

Sets the callback interface for timeline playback.

Parameters
cbCallback interface for timeline playback

◆ setPlaybackCallback2()

void com.meicam.sdk.NvsStreamingContext.setPlaybackCallback2 ( PlaybackCallback2  cb)
inline

Sets second callback interface for timeline playback.

Parameters
cbThe second callback interface for timeline playback

◆ setPlaybackDelayCallback()

void com.meicam.sdk.NvsStreamingContext.setPlaybackDelayCallback ( PlaybackDelayCallback  cb)
inline

Sets callback interface for delay playback.

Parameters
cbCallback interface for delay playback

◆ setPlaybackExceptionCallback()

void com.meicam.sdk.NvsStreamingContext.setPlaybackExceptionCallback ( PlaybackExceptionCallback  cb)
inline

Sets callback interface for playback exception.

Parameters
cbCallback interface for playback exception

◆ setRecordVideoBitrateMultiplier()

void com.meicam.sdk.NvsStreamingContext.setRecordVideoBitrateMultiplier ( float  recordVideoBitrateMultiplier)
inline

Set the rate multiplier for recording video.

Parameters
recordVideoBitrateMultiplierMultiplier
Since
1.5.0
See also
getRecordVideoBitrateMultiplier

◆ setSeekingCallback()

void com.meicam.sdk.NvsStreamingContext.setSeekingCallback ( SeekingCallback  cb)
inline

Sets the timeline search callback interface.

Parameters
cbCallback interface for search

◆ setStreamingEngineCallback()

void com.meicam.sdk.NvsStreamingContext.setStreamingEngineCallback ( StreamingEngineCallback  cb)
inline

Sets callback interface for streaming engine.

Parameters
cbCallback interface for streaming engine

◆ setTemplateCustomResourceDir()

void com.meicam.sdk.NvsStreamingContext.setTemplateCustomResourceDir ( String  templateUuid,
String  customResourceDir 
)
inline

set templates/project custom resource folders

Parameters
templateUuidproject/template resource package ID
customResourceDirPath of assets of project/template
Since
3.3.2

◆ setThemeEndingEnabled()

boolean com.meicam.sdk.NvsStreamingContext.setThemeEndingEnabled ( boolean  enable)
inline

Sets whether to display theme ending's special effects.

Returns
Returns a boolean value, yes means success and no means failure.
See also
setDefaultThemeEndingLogoImageFilePath

◆ setTimelineTimestampCallback()

void com.meicam.sdk.NvsStreamingContext.setTimelineTimestampCallback ( TimelineTimestampCallback  cb)
inline

Sets callback interface for timeline timestamp.

Parameters
cbCallback interface for timeline timestamp
Since
1.2.0

◆ setupHumanDetectionData()

static boolean com.meicam.sdk.NvsStreamingContext.setupHumanDetectionData ( int  dataType,
String  dataFilePath 
)
inlinestatic

Initializes human detection data pack.

Parameters
dataTypeType of human detection data pack, please refer to [HUMAN_DETECTION_DATA_TYPE].
dataFilePathThe path of data file.
Returns
Returns a value represent if it succeeded.
Since
2.6.0

◆ setUserWatermarkForCapture()

void com.meicam.sdk.NvsStreamingContext.setUserWatermarkForCapture ( String  watermarkFilePath,
int  displayWidth,
int  displayHeight,
float  opacity,
int  position,
int  marginX,
int  marginY 
)
inline

Adds a custom watermark for capturing video.

Parameters
watermarkFilePathPath of the watermark file, which should be a .PNG or .JPG file.
displayWidthThe width of the watermark displayed in the preview. If it is 0, the original width of the image is used.
displayHeightThe height of the watermark displayed in the preview. If it is 0, the original height of the image is used.
opacityWatermark opacity, the range of which is 0~1
positionPosition of the watermark, please refer to NvsTimelineWatermarkPosition.
marginXWatermark horizontal margin
marginYWatermark vertical margin
Since
2.0.1

◆ setVideoStabilization()

void com.meicam.sdk.NvsStreamingContext.setVideoStabilization ( int  flags)
inline

Sets video stabilization.

Parameters
flagsVideo stabilization value.Please refer to Flag of stabilization.
See also
getVideoStabilization

◆ setZoom()

void com.meicam.sdk.NvsStreamingContext.setZoom ( int  zoom)
inline

Sets the zoom value.

Parameters
zoomZoom ratio
See also
getZoom
getCaptureDeviceCapability

◆ startAutoFocus()

void com.meicam.sdk.NvsStreamingContext.startAutoFocus ( RectF  focusRect)
inline

Starts autofocus.

Parameters
focusRectThe target area for autofocus, of which coordinates are in live-window's coordinate system
See also
cancelAutoFocus

◆ startBufferCapturePreview()

boolean com.meicam.sdk.NvsStreamingContext.startBufferCapturePreview ( int  width,
int  heidht,
NvsRational  fps,
int  rotation,
boolean  flipHorizontally 
)
inline

Starts the capture preview with inputting buffer mode.

Parameters
widthInput buffer width.
heidhtInput buffer height.
fpsInput buffer framerate.
rotationInput buffer rotation angle. Please refer to Image rotation angle of input buffer
flipHorizontallywhether to flip the buffer horizontally.
Returns
Returns boolean value. YES indicates that the preview is started successfully, and NO means the opposite.
See also
sendBufferToCapturePreview

◆ startCapturePreview()

boolean com.meicam.sdk.NvsStreamingContext.startCapturePreview ( int  captureDeviceIndex,
int  videoResGrade,
int  flags,
NvsRational  aspectRatio 
)
inline

Starts the capture preview.

Parameters
captureDeviceIndexIndex of the capture device
videoResGradeGrade for video capture resolution. Please refer to Grade for video capture resolution. The video resolution grade means the shorter edge's resolution value when capturing video (could be the height or the width). According to the aspectRatio (if null then system's capturing device will determine aspect ratio), another edge's resolution value will be calculated (could be the height or the width). Four grades include LOW, MEDIUM, HIGH and SUPER_HIGH, of which correspond to 360p, 480p, 720p and 1080p. Android SDK's front-faced and back-faced cameras should be of the same resolution grade. There are two ways to record, recording with special effects and without. When recording with special effects (not using the system's built-in recorder), the SDK will evaluate user's phone's processing ability. If the phone is capable of process the recorded video, then the video will be recorded in resolution grade as set. If not, the SDK will lower the resolution grade to a level that the user's phone are capable of. For example: when using certain model of phone and setting to SUPER_HIGH grade, of which the phone are not capable of supporting, the SDK will lower the grade to HIGH or MEDIUM, thus resulting the grade recorded is not same as the grade user sets. Likewise, if recording without special effects (using the system's built-in camera), then the resolution grade will be determined according to camera's capability. If the camera cannot satisfy the grade setted, the SDK would lower the resolution grade when recording. If the user wants to customize the recording resolution, say 540*960 pixels, then the user will need to record a video with identical aspect ratio, create a timeline with aspect ratio of 540*960 and compile it to file. When compiling, there is no grade corresponding to a height of 960p, thus the user needs to call setCustomCompileVideoHeight() to customize the height before compilation. Then the user needs to call compileTimeline(), with the height grade set to COMPILE_VIDEO_RESOLUTION_GRADE_CUSTOM. The code may be used as follows:
    NvsVideoResolution videoEditRes = new NvsVideoResolution();
    videoEditRes.imageWidth = 540;
    videoEditRes.imageHeight = 960;
    videoEditRes.imagePAR = new NvsRational(1, 1);
    NvsRational videoFps = new NvsRational(25, 1);

    NvsAudioResolution audioEditRes = new NvsAudioResolution();
    audioEditRes.sampleRate = 44100;
    audioEditRes.channelCount = 2;

    mTimeline = mStreamingContext.createTimeline(videoEditRes, videoFps, audioEditRes);
    mStreamingContext.setCustomCompileVideoHeight(960);
    mStreamingContext.compileTimeline(mTimeline, 0, mTimeline.getDuration(), m_compilePath,
    NvsStreamingContext.COMPILE_VIDEO_RESOLUTION_GRADE_CUSTOM, NvsStreamingContext.COMPILE_BITRATE_GRADE_HIGH, 0);
flagsFlag field, if there is no special requirement, please fill in 0. Please refer to Flag of capturing. The application scene for each flag is as follows:
STREAMING_ENGINE_CAPTURE_FLAG_GRAB_CAPTURED_VIDEO_FRAME which is used in grabing video frameļ¼›
STREAMING_ENGINE_CAPTURE_FLAG_STRICT_PREVIEW_VIDEO_SIZE is used for face detection combination STREAMING_ENGINE_CAPTURE_FLAG_CAPTURE_BUDDY_HOST_VIDEO_FRAME;
STREAMING_ENGINE_CAPTURE_FLAG_DONT_USE_SYSTEM_RECORDER which used for recording video with special effects.
NvsStreamingEngineCaptureFlag_DontCaptureAudio Used for live video without audio stream. Usually not used.
aspectRatioAspect ratio for previewing, setting null means that it will be determined by the system capture device.
Returns
Returns boolean value. YES indicates that the preview is started successfully, and NO means the opposite.

◆ startCapturePreviewWithSpecialSize()

boolean com.meicam.sdk.NvsStreamingContext.startCapturePreviewWithSpecialSize ( int  captureDeviceIndex,
int  videoResGrade,
int  flags,
NvsSize  previewSize 
)
inline

Starts the capture preview.

Parameters
captureDeviceIndexIndex of the capture device
videoResGradeGrade for video capture resolution.
flagsFlag field, if there is no special requirement, please fill in 0.
previewSizevideo preview size.
Returns
Returns boolean value. YES indicates that the preview is started successfully, and NO means the opposite.
See also
startCapturePreview

◆ StartContinuousFocus()

void com.meicam.sdk.NvsStreamingContext.StartContinuousFocus ( )
inline

Starts continuous focus.

◆ startDualBufferCapturePreview()

boolean com.meicam.sdk.NvsStreamingContext.startDualBufferCapturePreview ( SurfaceTexture  surfaceTexture,
int  surfaceTextureWidth,
int  surfaceTextureHeight,
int  surfaceTextureRotation,
int  cpuBufferWidth,
int  cpuBufferHeight,
boolean  cpuBufferFlipHorizontally,
int  cpuBufferRotation,
NvsRational  fps,
int  flags 
)
inline

Starts dual buffer mode for capture preview, one input is from SurfaceTexture and another is from cpu buffer. Two input must be of the same size when rotated to positive direction.

Parameters
surfaceTextureSurface texture object
surfaceTextureWidthWidth of the input SurfaceTexture buffer
surfaceTextureHeightHeight of the input SurfaceTexture buffer
surfaceTextureRotationRotation angle of input SurfaceTexture buffer (clockwise). Please refer to Input the image rotation angle of the buffer.
cpuBufferWidthWidth of input cpu buffer
cpuBufferHeightHeight of input cpu buffer
cpuBufferFlipHorizontallyWhether input cpu buffer is flipped horizontally (prior to rotation)
cpuBufferRotationRotation angle of input cpu buffer (clockwise). please refer to Input the image rotation angle of the buffer
fpsfps of input buffer
flagsFlag value, if no special requirements please input 0. Please refer to STREAMING_ENGINE_CAPTURE_FLAG.
Returns
Returns a boolean value. True means preview starts successfully and false means the opposite.
See also
sendBufferToCapturePreview

◆ startRecording() [1/3]

boolean com.meicam.sdk.NvsStreamingContext.startRecording ( String  outputFilePath)
inline

Starts recording. Please refer to Method of Recording Video.

Parameters
outputFilePathThe path to the recording file.
Returns
Returns a boolean value. Returning YES means it starts recording successfully, and NO means it fails to start.
See also
stopRecording

◆ startRecording() [2/3]

boolean com.meicam.sdk.NvsStreamingContext.startRecording ( String  outputFilePath,
int  flags 
)
inline

Starts recording. Please refer to Method of Recording Video.

Parameters
outputFilePathThe path to the recording file.
flagsFlag field, if there is no special requirement, please fill in 0. Please refer to Flag of recording.
Returns
Returns a boolean value. Returning YES means it starts recording successfully, and NO means it fails to start.
Since
1.5.1
See also
stopRecording

◆ startRecording() [3/3]

boolean com.meicam.sdk.NvsStreamingContext.startRecording ( String  outputFilePath,
int  flags,
Hashtable< String, Object >  recordConfigurations 
)
inline

Starts recording. Please refer to Method of Recording Video.

Parameters
outputFilePathThe path to the recording file. Note: .mov is recommended as the output format.
flagsFlag field, if there is no special requirement, please fill in 0. Please refer to Flag of recording.
recordConfigurationsConfigurations for recording videos. For key values in Hashtable,please refer to Configurations of recording video.
For instanceļ¼š
 Hashtable<String, Object> config = new Hashtable<>();
 config.put(NvsStreamingContext.RECORD_GOP_SIZE, 15); //If set to 1 then a I-frame-only video is compiled. (Note: some android phones cannot compile I-frame-only video. In this case,please use STREAMING_ENGINE_COMPILE_FLAG_DISABLE_HARDWARE_ENCODER to encode)
 config.put(NvsStreamingContext.RECORD_BITRATE, 10000000); // 10M bps
Returns
Returns a boolean value. Returning YES means it starts recording successfully, and NO means it fails to start.
Since
1.5.1
See also
stopRecording

◆ stop() [1/2]

void com.meicam.sdk.NvsStreamingContext.stop ( )
inline

Stops the engine.

◆ stop() [2/2]

void com.meicam.sdk.NvsStreamingContext.stop ( int  flags)
inline

Stops the engine.

Parameters
flagsEngine stop flags. Please refer to Engine stop flags.
Since
1.16.0

◆ stopRecording() [1/2]

void com.meicam.sdk.NvsStreamingContext.stopRecording ( )
inline

Stops recording.

See also
startRecording

◆ stopRecording() [2/2]

void com.meicam.sdk.NvsStreamingContext.stopRecording ( boolean  synchronous)
inline

Stops recording.

Parameters
synchronoussynchronous flag.
See also
startRecording

◆ takePicture()

boolean com.meicam.sdk.NvsStreamingContext.takePicture ( int  flags)
inline

take a picture with the max resolution of camera which matches the preview resolution best

Parameters
flagstake picture flag. value is 0
See also
startRecording

◆ toggleFlash()

void com.meicam.sdk.NvsStreamingContext.toggleFlash ( boolean  flashOn)
inline

Sets which the flash light is on/off.

Parameters
flashOnwhether the flash light is on or not
See also
isFlashOn

◆ toggleFlashMode()

void com.meicam.sdk.NvsStreamingContext.toggleFlashMode ( int  mode)
inline

Sets the flash mode.

Parameters
modeflash mode value, please refer to Flash Mode
See also
getFlashMode

Member Data Documentation

◆ ASSET_PACKAGE_ASPECT_RATIO_16v9

final int com.meicam.sdk.NvsStreamingContext.ASSET_PACKAGE_ASPECT_RATIO_16v9 = 1
static

◆ ASSET_PACKAGE_ASPECT_RATIO_18v9

final int com.meicam.sdk.NvsStreamingContext.ASSET_PACKAGE_ASPECT_RATIO_18v9 = 32
static

◆ ASSET_PACKAGE_ASPECT_RATIO_1v1

final int com.meicam.sdk.NvsStreamingContext.ASSET_PACKAGE_ASPECT_RATIO_1v1 = 2
static

◆ ASSET_PACKAGE_ASPECT_RATIO_3v4

final int com.meicam.sdk.NvsStreamingContext.ASSET_PACKAGE_ASPECT_RATIO_3v4 = 16
static

◆ ASSET_PACKAGE_ASPECT_RATIO_4v3

final int com.meicam.sdk.NvsStreamingContext.ASSET_PACKAGE_ASPECT_RATIO_4v3 = 8
static

◆ ASSET_PACKAGE_ASPECT_RATIO_9v16

final int com.meicam.sdk.NvsStreamingContext.ASSET_PACKAGE_ASPECT_RATIO_9v16 = 4
static

◆ ASSET_PACKAGE_ASPECT_RATIO_9v18

final int com.meicam.sdk.NvsStreamingContext.ASSET_PACKAGE_ASPECT_RATIO_9v18 = 64
static

◆ AV_FILEINFO_EXTRA_INFO

final int com.meicam.sdk.NvsStreamingContext.AV_FILEINFO_EXTRA_INFO = AV_FILEINFO_EXTRA_PIXELFORMAT
static

◆ AV_FILEINFO_EXTRA_NULL

final int com.meicam.sdk.NvsStreamingContext.AV_FILEINFO_EXTRA_NULL = 0
static

◆ AV_FILEINFO_EXTRA_PIXELFORMAT

final int com.meicam.sdk.NvsStreamingContext.AV_FILEINFO_EXTRA_PIXELFORMAT = 1
static

◆ AV_FILEINFO_EXTRA_VIDEO_CODEC_ID

final int com.meicam.sdk.NvsStreamingContext.AV_FILEINFO_EXTRA_VIDEO_CODEC_ID = 2
static

◆ BUFFER_IMAGE_ROTATION_0

final int com.meicam.sdk.NvsStreamingContext.BUFFER_IMAGE_ROTATION_0 = 0
static

◆ BUFFER_IMAGE_ROTATION_180

final int com.meicam.sdk.NvsStreamingContext.BUFFER_IMAGE_ROTATION_180 = 2
static

◆ BUFFER_IMAGE_ROTATION_270

final int com.meicam.sdk.NvsStreamingContext.BUFFER_IMAGE_ROTATION_270 = 3
static

◆ BUFFER_IMAGE_ROTATION_90

final int com.meicam.sdk.NvsStreamingContext.BUFFER_IMAGE_ROTATION_90 = 1
static

◆ CAMERA_FLASH_MODE_AUTO

final int com.meicam.sdk.NvsStreamingContext.CAMERA_FLASH_MODE_AUTO = 4
static

Turns On flash to auto.

◆ CAMERA_FLASH_MODE_OFF

final int com.meicam.sdk.NvsStreamingContext.CAMERA_FLASH_MODE_OFF = 1
static

Turns off flash.

◆ CAMERA_FLASH_MODE_ON

final int com.meicam.sdk.NvsStreamingContext.CAMERA_FLASH_MODE_ON = 2
static

Turns On flash.

◆ CAMERA_FLASH_MODE_TORCH

final int com.meicam.sdk.NvsStreamingContext.CAMERA_FLASH_MODE_TORCH = 8
static

Turns On torch.

◆ CAPTURE_DEVICE_ERROR_FAIL_TO_CONNECT

final int com.meicam.sdk.NvsStreamingContext.CAPTURE_DEVICE_ERROR_FAIL_TO_CONNECT = 4
static

Capture device's error, the server died

◆ CAPTURE_DEVICE_ERROR_FAIL_TO_START

final int com.meicam.sdk.NvsStreamingContext.CAPTURE_DEVICE_ERROR_FAIL_TO_START = 3
static

Capture device's error, the server died.

◆ CAPTURE_DEVICE_ERROR_SERVER_DIED

final int com.meicam.sdk.NvsStreamingContext.CAPTURE_DEVICE_ERROR_SERVER_DIED = 2
static

Capture device's error, the server died.

◆ CAPTURE_DEVICE_ERROR_UNKNOWN

final int com.meicam.sdk.NvsStreamingContext.CAPTURE_DEVICE_ERROR_UNKNOWN = 1
static

Unknown error with the capturing device.

◆ CLEAR_CACHE_FLAG_AVFILE_INFO

final int com.meicam.sdk.NvsStreamingContext.CLEAR_CACHE_FLAG_AVFILE_INFO = 8
static

Cache of avfile infors.

◆ CLEAR_CACHE_FLAG_AVFILE_KEYFRAME_INFO

final int com.meicam.sdk.NvsStreamingContext.CLEAR_CACHE_FLAG_AVFILE_KEYFRAME_INFO = 16
static

Cache of video's key frame infos.

◆ CLEAR_CACHE_FLAG_CAPTION_FONT_INFO

final int com.meicam.sdk.NvsStreamingContext.CLEAR_CACHE_FLAG_CAPTION_FONT_INFO = 32
static

Cache of font infos.

◆ CLEAR_CACHE_FLAG_ICON_ENGINE

final int com.meicam.sdk.NvsStreamingContext.CLEAR_CACHE_FLAG_ICON_ENGINE = 2
static

Cache of icon engine.

◆ CLEAR_CACHE_FLAG_STREAMING_ENGINE

final int com.meicam.sdk.NvsStreamingContext.CLEAR_CACHE_FLAG_STREAMING_ENGINE = 1
static

Cache of streaming engine.

◆ CLEAR_CACHE_FLAG_WAVEFORM_ENGINE

final int com.meicam.sdk.NvsStreamingContext.CLEAR_CACHE_FLAG_WAVEFORM_ENGINE = 4
static

Cache of waveform engine.

◆ COMPILE_AUDIO_BITRATE

final String com.meicam.sdk.NvsStreamingContext.COMPILE_AUDIO_BITRATE = "audio bitrate"
static

Compile audio bitrate in bps, type: int, such as 128000 for 128k bitrate.

◆ COMPILE_AUDIO_CHANNELS_MODE

final String com.meicam.sdk.NvsStreamingContext.COMPILE_AUDIO_CHANNELS_MODE = "audio channels mode"
static

Set up audio channels, currently supporting "mixtomono", with default and timeline settings consistent.

◆ COMPILE_AUDIO_ENCODER_NAME

final String com.meicam.sdk.NvsStreamingContext.COMPILE_AUDIO_ENCODER_NAME = "audio encoder name"
static

Assigned audio encoding format, "amr-wb", "vorbis" and "mp3" are supported, default is "aac".

◆ COMPILE_AUDIO_SAMPLE_RATE

final String com.meicam.sdk.NvsStreamingContext.COMPILE_AUDIO_SAMPLE_RATE = "audio sample rate"
static

Set the audio sampling rate, currently supporting a minimum of 16K and a maximum of 128K.

◆ COMPILE_BITRATE

final String com.meicam.sdk.NvsStreamingContext.COMPILE_BITRATE = "bitrate"
static

Compile bitrate in bpsļ¼Œtype: int, such as 3000000 for 3M biterate.

◆ COMPILE_BITRATE_GRADE_HIGH

final int com.meicam.sdk.NvsStreamingContext.COMPILE_BITRATE_GRADE_HIGH = 2
static

High bitrate for video compiled.

◆ COMPILE_BITRATE_GRADE_LOW

final int com.meicam.sdk.NvsStreamingContext.COMPILE_BITRATE_GRADE_LOW = 0
static

Low bitrate for video compiled.

◆ COMPILE_BITRATE_GRADE_MEDIUM

final int com.meicam.sdk.NvsStreamingContext.COMPILE_BITRATE_GRADE_MEDIUM = 1
static

Medium bitrate for video compiled.

◆ COMPILE_CREATION_TIME

final String com.meicam.sdk.NvsStreamingContext.COMPILE_CREATION_TIME = "creation time"
static

Set creation time for this file. Foramt:"YYYY-MM-DDTHH:MM:SS",eg:2010-12-24T12:00:00(use location time)

◆ COMPILE_ENCODE_PROFILE_BASELINE

final int com.meicam.sdk.NvsStreamingContext.COMPILE_ENCODE_PROFILE_BASELINE = 1
static

base line profile for video encode

◆ COMPILE_ENCODE_PROFILE_HIGH

final int com.meicam.sdk.NvsStreamingContext.COMPILE_ENCODE_PROFILE_HIGH = 3
static

High profile for video encode.

◆ COMPILE_ENCODE_PROFILE_MAIN

final int com.meicam.sdk.NvsStreamingContext.COMPILE_ENCODE_PROFILE_MAIN = 2
static

main profile for video encode

◆ COMPILE_ERROR_TYPE_Cancelation

final int com.meicam.sdk.NvsStreamingContext.COMPILE_ERROR_TYPE_Cancelation = 1
static

◆ COMPILE_ERROR_TYPE_MUXING_ERROR

final int com.meicam.sdk.NvsStreamingContext.COMPILE_ERROR_TYPE_MUXING_ERROR = 5
static

◆ COMPILE_ERROR_TYPE_NO_ERROR

final int com.meicam.sdk.NvsStreamingContext.COMPILE_ERROR_TYPE_NO_ERROR = 0
static

◆ COMPILE_ERROR_TYPE_VIDEO_DECODING_ERROR

final int com.meicam.sdk.NvsStreamingContext.COMPILE_ERROR_TYPE_VIDEO_DECODING_ERROR = 4
static

◆ COMPILE_ERROR_TYPE_VIDEO_ENCODER_SETUP_ERROR

final int com.meicam.sdk.NvsStreamingContext.COMPILE_ERROR_TYPE_VIDEO_ENCODER_SETUP_ERROR = 2
static

◆ COMPILE_ERROR_TYPE_VIDEO_ENCODING_ERROR

final int com.meicam.sdk.NvsStreamingContext.COMPILE_ERROR_TYPE_VIDEO_ENCODING_ERROR = 3
static

◆ COMPILE_FILE_META_DATA

final String com.meicam.sdk.NvsStreamingContext.COMPILE_FILE_META_DATA = "file metadata"
static

Set meta data, for example:"creation-time=xxxxx;location=17.641347+160.931648;".

◆ COMPILE_FPS

final String com.meicam.sdk.NvsStreamingContext.COMPILE_FPS = "fps"
static

frames per second when compiling, type: NvsRational

◆ COMPILE_GOP_SIZE

final String com.meicam.sdk.NvsStreamingContext.COMPILE_GOP_SIZE = "gopsize"
static

Compile GOP size, type: int, default is 30.

◆ COMPILE_LOCATION

final String com.meicam.sdk.NvsStreamingContext.COMPILE_LOCATION = "location"
static

Set location for this file. eg:17.641347+160.931648.

◆ COMPILE_LOSSLESS_AUDIO

final String com.meicam.sdk.NvsStreamingContext.COMPILE_LOSSLESS_AUDIO = "lossless audio"
static

Whether to compile lossless audio, type: booleanļ¼Œdefault is false.

◆ COMPILE_METADATADESCRIPTION

final String com.meicam.sdk.NvsStreamingContext.COMPILE_METADATADESCRIPTION = "metadata description"
static

sets the metadata description of the video files

◆ COMPILE_OPTIMIZE_FOR_NETWORK_USE

final String com.meicam.sdk.NvsStreamingContext.COMPILE_OPTIMIZE_FOR_NETWORK_USE = "optimize-for-network-use"
static

Whether to prepose the index table, type: booleanļ¼Œdefault is false.

◆ COMPILE_SOFTWARE_ENCODER_CRF

final String com.meicam.sdk.NvsStreamingContext.COMPILE_SOFTWARE_ENCODER_CRF = "software encorder crf"
static

Preset crf parameters for software encoder, type: int, range is [1, 99], less is betterļ¼Œdefault is 23.

◆ COMPILE_SOFTWARE_ENCODER_CRF_BITRATE_MAX

final String com.meicam.sdk.NvsStreamingContext.COMPILE_SOFTWARE_ENCODER_CRF_BITRATE_MAX = "software encorder crf bitrate max"
static

Preset maximum bitrate for software encoder in crf mode, type: int.

◆ COMPILE_SOFTWARE_ENCODER_MODE

final String com.meicam.sdk.NvsStreamingContext.COMPILE_SOFTWARE_ENCODER_MODE = "software encorder mode"
static

Software encoder mode, type: string, support ā€œabrā€ć€ā€œcrfā€ļ¼Œdefault is crf.

◆ COMPILE_SOFTWARE_ENCODER_PRESET

final String com.meicam.sdk.NvsStreamingContext.COMPILE_SOFTWARE_ENCODER_PRESET = "software encorder preset"
static

Preset parameters for software encoder, type: string, default is "faster", can support "ultrafast"ļ¼Œ"superfast"ļ¼Œ"veryfast"ļ¼Œ"faster"ļ¼Œ "fast"ļ¼Œ"medium"ļ¼Œ"slow"ļ¼Œ"slower"ļ¼Œ"veryslow"ļ¼Œ"placebo".

◆ COMPILE_USE_OPERATING_RATE

final String com.meicam.sdk.NvsStreamingContext.COMPILE_USE_OPERATING_RATE = "use operating rate"
static

Whether to use operating rate, type: boolean.

◆ COMPILE_VIDEO_BITRATE_MODE

final String com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_BITRATE_MODE = "bitrate mode"
static

Compile bitrate mode, Currently supported "cbr" and "vbr".

◆ COMPILE_VIDEO_CACHE_FILE_DURATION

final String com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_CACHE_FILE_DURATION = "cache file duration"
static

Breakpoint continuation cache file duration.

◆ COMPILE_VIDEO_CACHE_FILE_PATH

final String com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_CACHE_FILE_PATH = "cache file path"
static

Breakpoint continuation cache file path.

◆ COMPILE_VIDEO_ENABLE_BREAKPOINT_CONTINUATION

final String com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_ENABLE_BREAKPOINT_CONTINUATION = "enable breakpoint continuation"
static

Set whether enable breakpoint continuation.

◆ COMPILE_VIDEO_ENCODER_GIF_STATS_MODE

final String com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_ENCODER_GIF_STATS_MODE = "gif stats mode"
static

Set the statistical mode for GIF export. Currently, it supports diff, single, and defaults to single mode. If set to diff mode, it is best to export GIF for no more than 10 seconds. In this mode, memory requirements are relatively high.

◆ COMPILE_VIDEO_ENCODER_NAME

final String com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_ENCODER_NAME = "video encoder name"
static

Assigned video encoding format, "hevc"(h.265), "vp8"(The audio encoder must be Vorbis and the file format must be WebM) is supported, default is "h.264".

◆ COMPILE_VIDEO_ENCODER_PROFILE

final String com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_ENCODER_PROFILE = "encorder profile"
static

Assigned video encoding profile, type: int, values are 0 means none, 1 means baseline, 2 means main, 3 means high.

◆ COMPILE_VIDEO_ENCODER_SUPPORT_ALPHA_CHANNEL

final String com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_ENCODER_SUPPORT_ALPHA_CHANNEL = "alpha channel supported"
static

Alpah channel is supported. Now, only VP8 format is supported.

◆ COMPILE_VIDEO_HDR_COLOR_TRANSFER

final String com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_HDR_COLOR_TRANSFER = "encorder color transfer"
static

Set color transfer for HDR to encode, curve: string, default is "none", can support "st2084" and "hlg", and "hdr10plus",.

◆ COMPILE_VIDEO_RESOLUTION_GRADE_1080

final int com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_RESOLUTION_GRADE_1080 = 3
static

Compiles the video with height 1080.

◆ COMPILE_VIDEO_RESOLUTION_GRADE_2160

final int com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_RESOLUTION_GRADE_2160 = 4
static

Compiles the video with height 2160.

◆ COMPILE_VIDEO_RESOLUTION_GRADE_360

final int com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_RESOLUTION_GRADE_360 = 0
static

Compiles the video with height 360(the width of video is determined by height and the selected width when creating timeline, caculated by resolution ratio)

◆ COMPILE_VIDEO_RESOLUTION_GRADE_480

final int com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_RESOLUTION_GRADE_480 = 1
static

Compiles the video with height 480.

◆ COMPILE_VIDEO_RESOLUTION_GRADE_720

final int com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_RESOLUTION_GRADE_720 = 2
static

Compiles the video with height 720.

◆ COMPILE_VIDEO_RESOLUTION_GRADE_CUSTOM

final int com.meicam.sdk.NvsStreamingContext.COMPILE_VIDEO_RESOLUTION_GRADE_CUSTOM = 256
static

Customizes the height of video compiledļ¼Œmust be used with the API named setCustomCompileVideoHeight.

◆ CREATE_TIMELINE_FLAG_DONT_ADD_DEFAULT_VIDEO_TRANSITION

final int com.meicam.sdk.NvsStreamingContext.CREATE_TIMELINE_FLAG_DONT_ADD_DEFAULT_VIDEO_TRANSITION = 16
static

Do not add a default video transition.

◆ CREATE_TIMELINE_FLAG_LONGEST_DURATION_CONSIDER_ALL_TRACKS

final int com.meicam.sdk.NvsStreamingContext.CREATE_TIMELINE_FLAG_LONGEST_DURATION_CONSIDER_ALL_TRACKS = 1
static

timeline's longest duration consider all tracks

◆ CREATE_TIMELINE_FLAG_ORPHAN

final int com.meicam.sdk.NvsStreamingContext.CREATE_TIMELINE_FLAG_ORPHAN = 128
static

Orphan timeline flag, destroy the timeline after its parent timeline destroyed.

◆ CREATE_TIMELINE_FLAG_SYANC_AUDIO_VIDEO_TRANS_ON_VIDEO_TRACK

final int com.meicam.sdk.NvsStreamingContext.CREATE_TIMELINE_FLAG_SYANC_AUDIO_VIDEO_TRANS_ON_VIDEO_TRACK = 2
static

Sync audio transition and video transiton on video track.

◆ CREATE_TIMELINE_FLAG_TIMELINE_SIZE_USED_IN_VARIANT_SIZE_MODE

final int com.meicam.sdk.NvsStreamingContext.CREATE_TIMELINE_FLAG_TIMELINE_SIZE_USED_IN_VARIANT_SIZE_MODE = 256
static

Forced use of timeline resolution in automatically adapt timeline resolution model.

◆ CREATE_TIMELINE_FLAG_USE_MIPMAP

final int com.meicam.sdk.NvsStreamingContext.CREATE_TIMELINE_FLAG_USE_MIPMAP = 4
static

Use mipmap anti-aliasing.

◆ CREATE_TIMELINE_FLAG_VARIANT_IMAGE_SIZE

final int com.meicam.sdk.NvsStreamingContext.CREATE_TIMELINE_FLAG_VARIANT_IMAGE_SIZE = 8
static

Automatically adapt timeline resolution when add images.

◆ DEVICE_POWER_LEVEL_HIGH

final int com.meicam.sdk.NvsStreamingContext.DEVICE_POWER_LEVEL_HIGH = 2
static

high level

◆ DEVICE_POWER_LEVEL_LOW

final int com.meicam.sdk.NvsStreamingContext.DEVICE_POWER_LEVEL_LOW = 0
static

low level

◆ DEVICE_POWER_LEVEL_MEDIUM

final int com.meicam.sdk.NvsStreamingContext.DEVICE_POWER_LEVEL_MEDIUM = 1
static

medium level

◆ DEVICE_POWER_LEVEL_UNKNOWN

final int com.meicam.sdk.NvsStreamingContext.DEVICE_POWER_LEVEL_UNKNOWN = -1
static

unknown level

◆ ENCORDER_COLOR_TRANSFER

final String com.meicam.sdk.NvsStreamingContext.ENCORDER_COLOR_TRANSFER = "encorder color transfer"
static

Set color transfer for HDR to encode, curve: string, default is "none", can support "st2084" and "hlg",.

◆ HDR_CAPABILITY_FLAG_SUPPORTED_BY_EDITING

final int com.meicam.sdk.NvsStreamingContext.HDR_CAPABILITY_FLAG_SUPPORTED_BY_EDITING = 2
static

Editing Support HDR.

◆ HDR_CAPABILITY_FLAG_SUPPORTED_BY_EXPORTER

final int com.meicam.sdk.NvsStreamingContext.HDR_CAPABILITY_FLAG_SUPPORTED_BY_EXPORTER = 4
static

Support exporting HDR video.

◆ HDR_CAPABILITY_FLAG_SUPPORTED_BY_IMPORTER

final int com.meicam.sdk.NvsStreamingContext.HDR_CAPABILITY_FLAG_SUPPORTED_BY_IMPORTER = 1
static

Support importing HDR video.

◆ HDR_CAPABILITY_FLAG_SUPPORTED_BY_LIVEWINDOW

final int com.meicam.sdk.NvsStreamingContext.HDR_CAPABILITY_FLAG_SUPPORTED_BY_LIVEWINDOW = 8
static

Livewindow support HDR.

◆ HUMAN_DETECTION_DATA_TYPE_CUSTOM_AVATAR

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_DATA_TYPE_CUSTOM_AVATAR = 5
static

Custom avatar data pack type.

◆ HUMAN_DETECTION_DATA_TYPE_FAKE_FACE

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_DATA_TYPE_FAKE_FACE = 0
static

Fake face data pack type.

◆ HUMAN_DETECTION_DATA_TYPE_MAKEUP

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_DATA_TYPE_MAKEUP = 1
static

Makeup data pack type.

◆ HUMAN_DETECTION_DATA_TYPE_MAKEUP2

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_DATA_TYPE_MAKEUP2 = 6
static

Makeup2 data pack type.

◆ HUMAN_DETECTION_DATA_TYPE_PE106

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_DATA_TYPE_PE106 = 3
static

PE 106 data pack type.

◆ HUMAN_DETECTION_DATA_TYPE_PE240

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_DATA_TYPE_PE240 = 4
static

PE 240 data pack type.

◆ HUMAN_DETECTION_DATA_TYPE_SKIN_COLOR

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_DATA_TYPE_SKIN_COLOR = 2
static

Skin color data pack type.

◆ HUMAN_DETECTION_FEATURE_AVATAR_EXPRESSION

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_AVATAR_EXPRESSION = 4
static

Avatar Expressions of human face.

◆ HUMAN_DETECTION_FEATURE_EXTRA

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_EXTRA = 128
static

Extra features of human face.

◆ HUMAN_DETECTION_FEATURE_EYEBALL_LANDMARK

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_EYEBALL_LANDMARK = 4096
static

Eyeball landmarks.

◆ HUMAN_DETECTION_FEATURE_FACE_ACTION

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_FACE_ACTION = 2
static

Actions of human face.

◆ HUMAN_DETECTION_FEATURE_FACE_ATTR

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_FACE_ATTR = 131072
static

Base face attributes.

◆ HUMAN_DETECTION_FEATURE_FACE_ATTR_SHAPE

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_FACE_ATTR_SHAPE = 262144
static

Face shape attribute

◆ HUMAN_DETECTION_FEATURE_FACE_LANDMARK

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_FACE_LANDMARK = 1
static

Landmarks on human face.

◆ HUMAN_DETECTION_FEATURE_HAND_ACTION

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_HAND_ACTION = 1024
static

Hand actions.

◆ HUMAN_DETECTION_FEATURE_HAND_BONE

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_HAND_BONE = 2048
static

Bone landmarks of hand.

◆ HUMAN_DETECTION_FEATURE_HAND_LANDMARK

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_HAND_LANDMARK = 512
static

Hand landmarks.

◆ HUMAN_DETECTION_FEATURE_IMAGE_MODE

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_IMAGE_MODE = 16
static

Image detection mode.

◆ HUMAN_DETECTION_FEATURE_MULTI_DETECT

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_MULTI_DETECT = 8192
static

Multiple detect, say multiple rois detection.

◆ HUMAN_DETECTION_FEATURE_MULTI_THREAD

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_MULTI_THREAD = 32
static

Multi thread detection.

◆ HUMAN_DETECTION_FEATURE_SEGMENTATION_BACKGROUND

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_SEGMENTATION_BACKGROUND = 256
static

Background segmentation.

◆ HUMAN_DETECTION_FEATURE_SEGMENTATION_HALF_BODY

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_SEGMENTATION_HALF_BODY = 65536
static

Half body segmentation.

◆ HUMAN_DETECTION_FEATURE_SEGMENTATION_SKY

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_SEGMENTATION_SKY = 16384
static

Sky segmentation.

◆ HUMAN_DETECTION_FEATURE_SEMI_IMAGE_MODE

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_SEMI_IMAGE_MODE = 32768
static

Semi-image detection mode.

◆ HUMAN_DETECTION_FEATURE_SINGLE_THREAD

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_SINGLE_THREAD = 64
static

Single thread detection.

◆ HUMAN_DETECTION_FEATURE_VIDEO_MODE

final int com.meicam.sdk.NvsStreamingContext.HUMAN_DETECTION_FEATURE_VIDEO_MODE = 8
static

Video detection mode.

◆ RECORD_BITRATE

final String com.meicam.sdk.NvsStreamingContext.RECORD_BITRATE = "bitrate"
static

Record bitrate in bpsļ¼Œtype: int, such as 3000000 for 3M biterate.

◆ RECORD_GOP_SIZE

final String com.meicam.sdk.NvsStreamingContext.RECORD_GOP_SIZE = "gopsize"
static

Record GOP size, type: int, default is 30.

◆ STREAMING_CONTEXT_FLAG_ASYNC_ENGINE_STATE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_ASYNC_ENGINE_STATE = 16
static

Switches engine states asynchronously to reduce main thread's jam.

◆ STREAMING_CONTEXT_FLAG_ASYNC_INITIALIZED

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_ASYNC_INITIALIZED = 64
static

Streaming Context is initialized asynchronously.

◆ STREAMING_CONTEXT_FLAG_COMPACT_MEMORY_MODE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_COMPACT_MEMORY_MODE = 2
static

Minimizes the memory occupation.

◆ STREAMING_CONTEXT_FLAG_DISABLE_ANDROID_CAMERA2

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_DISABLE_ANDROID_CAMERA2 = 8388608
static

Disable camera2 used.

◆ STREAMING_CONTEXT_FLAG_DISABLE_CAPTURE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_DISABLE_CAPTURE = 2048
static

Disable capture.

◆ STREAMING_CONTEXT_FLAG_ENABLE_HDR_DISPLAY_WHEN_SUPPORTED

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_ENABLE_HDR_DISPLAY_WHEN_SUPPORTED = 65536
static

Turn on HDR display mode, if the device supports.

◆ STREAMING_CONTEXT_FLAG_ENABLE_MAX_CACHE_CAPTION_LIMIT

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_ENABLE_MAX_CACHE_CAPTION_LIMIT = 1024
static

Enable max cache cont limit of caption.

◆ STREAMING_CONTEXT_FLAG_INTERRUPT_STOP_FOR_INTERNAL_STOP

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_INTERRUPT_STOP_FOR_INTERNAL_STOP = 262144
static

Interrupt stop is used for all internal stop, such as stop between seek state and playback state.

◆ STREAMING_CONTEXT_FLAG_NEED_GIF_MOTION

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_NEED_GIF_MOTION = 8192
static

GIF file use motion mode.

◆ STREAMING_CONTEXT_FLAG_NO_HARDWARE_VIDEO_READER

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_NO_HARDWARE_VIDEO_READER = 8
static

Disable hardware decoding.

◆ STREAMING_CONTEXT_FLAG_PLAYBACK_DROP_FRAME_MODE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_PLAYBACK_DROP_FRAME_MODE = 4096
static

Drop frame mode in playback timeline (abandon)

◆ STREAMING_CONTEXT_FLAG_SUPPORT_16K_EDIT

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_SUPPORT_16K_EDIT = 128
static

Supports 16K editting(only for pictures)

◆ STREAMING_CONTEXT_FLAG_SUPPORT_4K_EDIT

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_SUPPORT_4K_EDIT = 1
static

Supports 4K video editting.

◆ STREAMING_CONTEXT_FLAG_SUPPORT_8K_EDIT

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_SUPPORT_8K_EDIT = 4
static

Supports 8K edittingting(only for pictures)

◆ STREAMING_CONTEXT_FLAG_USE_FIXED_DEFAULT_CAPTION_CONTEXT_RESOLUTION

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_USE_FIXED_DEFAULT_CAPTION_CONTEXT_RESOLUTION = 4194304
static

Create default caption context with 1280 * 720 resolution.

◆ STREAMING_CONTEXT_FLAG_USE_SYSTEM_IMAGE_READER

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_FLAG_USE_SYSTEM_IMAGE_READER = 512
static

Use system image reader.

◆ STREAMING_CONTEXT_VIDEO_DECODER_WITHOUT_SURFACE_TEXTURE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_CONTEXT_VIDEO_DECODER_WITHOUT_SURFACE_TEXTURE = 32
static

Decoding not using the SurfaceTexture.

◆ STREAMING_ENGINE_CAPTURE_FLAG_CAPTURE_BUDDY_HOST_VIDEO_FRAME

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_CAPTURE_FLAG_CAPTURE_BUDDY_HOST_VIDEO_FRAME = 32
static

Records buddy video frame, used to detect face.

◆ STREAMING_ENGINE_CAPTURE_FLAG_DISABLE_FLIP_FOR_FRONT_CAMERA

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_CAPTURE_FLAG_DISABLE_FLIP_FOR_FRONT_CAMERA = 2048
static

Disable flip of front camera.

◆ STREAMING_ENGINE_CAPTURE_FLAG_DONT_CAPTURE_AUDIO

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_CAPTURE_FLAG_DONT_CAPTURE_AUDIO = 16
static

Does not record audio.

◆ STREAMING_ENGINE_CAPTURE_FLAG_DONT_USE_SYSTEM_RECORDER

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_CAPTURE_FLAG_DONT_USE_SYSTEM_RECORDER = 4
static

Not using the system built-in recorder to record.

◆ STREAMING_ENGINE_CAPTURE_FLAG_ENABLE_TAKE_PICTURE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_CAPTURE_FLAG_ENABLE_TAKE_PICTURE = 8192
static

Enable takc picture.

◆ STREAMING_ENGINE_CAPTURE_FLAG_FACE_ACTION_WITH_PARTICLE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_CAPTURE_FLAG_FACE_ACTION_WITH_PARTICLE = 256
static

Uses face action to control particle special effects.

◆ STREAMING_ENGINE_CAPTURE_FLAG_GRAB_CAPTURED_VIDEO_FRAME

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_CAPTURE_FLAG_GRAB_CAPTURED_VIDEO_FRAME = 1
static

Grabs frame from captured video (turnning on this flag would affect performance, turn on only when neccessary)

◆ STREAMING_ENGINE_CAPTURE_FLAG_INPUT_ASPECT_RATIO_USED

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_CAPTURE_FLAG_INPUT_ASPECT_RATIO_USED = 4096
static

Capture preview size aspect ratio use user input.

◆ STREAMING_ENGINE_CAPTURE_FLAG_LOW_PIPELINE_SIZE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_CAPTURE_FLAG_LOW_PIPELINE_SIZE = 512
static

Decreases the size of pipeline when engine is capturing.

◆ STREAMING_ENGINE_CAPTURE_FLAG_STRICT_PREVIEW_VIDEO_SIZE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_CAPTURE_FLAG_STRICT_PREVIEW_VIDEO_SIZE = 8
static

Resticts the preview video's size to system's built-in preview video size.

◆ STREAMING_ENGINE_COMPILE_FLAG_BUDDY_HOST_VIDEO_FRAME

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_BUDDY_HOST_VIDEO_FRAME = 32
static

buddy video frame in host, used to detect face

◆ STREAMING_ENGINE_COMPILE_FLAG_BUDDY_ORIGIN_VIDEO_FRAME

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_BUDDY_ORIGIN_VIDEO_FRAME = 8192
static

buddy video frame in host after decoding, used to detect face

◆ STREAMING_ENGINE_COMPILE_FLAG_DISABLE_ALIGN_VIDEO_SIZE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_DISABLE_ALIGN_VIDEO_SIZE = 256
static

◆ STREAMING_ENGINE_COMPILE_FLAG_DISABLE_HARDWARE_ENCODER

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_DISABLE_HARDWARE_ENCODER = 1
static

Disables the hardware encoder.

◆ STREAMING_ENGINE_COMPILE_FLAG_DISABLE_MEDIA_MUXER

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_DISABLE_MEDIA_MUXER = 16
static

disable MediaMuxer

◆ STREAMING_ENGINE_COMPILE_FLAG_DISABLE_PRELOADER_ON_SOURCE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_DISABLE_PRELOADER_ON_SOURCE = 64
static

disable preloader on video source

◆ STREAMING_ENGINE_COMPILE_FLAG_DONT_USE_INPUT_SURFACE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_DONT_USE_INPUT_SURFACE = 2
static

Not using input surface.

◆ STREAMING_ENGINE_COMPILE_FLAG_IGNORE_TIMELINE_VIDEO_SIZE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_IGNORE_TIMELINE_VIDEO_SIZE = 2048
static

The resolution of output video can be over timeline's resolution.

◆ STREAMING_ENGINE_COMPILE_FLAG_LOW_PIPELINE_SIZE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_LOW_PIPELINE_SIZE = 4096
static

Use low pipeline size to decrease CPU/GPU usage during compilation.

◆ STREAMING_ENGINE_COMPILE_FLAG_ONLY_AUDIO

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_ONLY_AUDIO = 8
static

Generate file only with audio stream.

◆ STREAMING_ENGINE_COMPILE_FLAG_ONLY_VIDEO

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_ONLY_VIDEO = 4
static

Generate file only with video stream.

◆ STREAMING_ENGINE_COMPILE_FLAG_TRUNCATE_AUDIO_STREAM

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_TRUNCATE_AUDIO_STREAM = 128
static

Truncat audio stream make sure no longer than the length of the video.

◆ STREAMING_ENGINE_COMPILE_FLAG_USE_SOFTWARE_AUDIO_ENCODER

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_USE_SOFTWARE_AUDIO_ENCODER = 1024
static

Software audio encoder used.

◆ STREAMING_ENGINE_COMPILE_FLAG_VARIABLE_FRAME_RATE_ENABLE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_COMPILE_FLAG_VARIABLE_FRAME_RATE_ENABLE = 16384
static

Enable variable frame rate export and the exported frame rate will change with the video frame rate.

◆ STREAMING_ENGINE_HARDWARE_ERROR_TYPE_VIDEO_DECODER_SETUP_ERROR

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_HARDWARE_ERROR_TYPE_VIDEO_DECODER_SETUP_ERROR = 2
static

◆ STREAMING_ENGINE_HARDWARE_ERROR_TYPE_VIDEO_DECODING_ERROR

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_HARDWARE_ERROR_TYPE_VIDEO_DECODING_ERROR = 3
static

◆ STREAMING_ENGINE_HARDWARE_ERROR_TYPE_VIDEO_ENCODER_SETUP_ERROR

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_HARDWARE_ERROR_TYPE_VIDEO_ENCODER_SETUP_ERROR = 0
static

◆ STREAMING_ENGINE_HARDWARE_ERROR_TYPE_VIDEO_ENCODING_ERROR

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_HARDWARE_ERROR_TYPE_VIDEO_ENCODING_ERROR = 1
static

◆ STREAMING_ENGINE_INTERRUPT_STOP

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_INTERRUPT_STOP = 4
static

Interrupting the decoding thread without waiting for the decoding to complete and stopping quickly will result in the final picture may be incorrect.

◆ STREAMING_ENGINE_PLAYBACK_EXCEPTION_TYPE_MEDIA_FILE_ERROR

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_PLAYBACK_EXCEPTION_TYPE_MEDIA_FILE_ERROR = 0
static

Media file error.

◆ STREAMING_ENGINE_PLAYBACK_FLAG_AUTO_CACHE_ALL_CAF_FRAMES

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_PLAYBACK_FLAG_AUTO_CACHE_ALL_CAF_FRAMES = 128
static

Cache all frames of caf file.

◆ STREAMING_ENGINE_PLAYBACK_FLAG_BUDDY_HOST_VIDEO_FRAME

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_PLAYBACK_FLAG_BUDDY_HOST_VIDEO_FRAME = 32
static

buddy video frame in host, used to detect face

◆ STREAMING_ENGINE_PLAYBACK_FLAG_BUDDY_ORIGIN_VIDEO_FRAME

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_PLAYBACK_FLAG_BUDDY_ORIGIN_VIDEO_FRAME = 2048
static

buddy video frame in host after decoding, used to detect face

◆ STREAMING_ENGINE_PLAYBACK_FLAG_DISABLE_DROP_FRAME_MODE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_PLAYBACK_FLAG_DISABLE_DROP_FRAME_MODE = 16384
static

Disable the frame dropping mode for playback. If this flag is not added, the SDK will ensure continuous audio playback. If the video rendering is complex and so on, it will use the frame dropping mode to ensure video and audio synchronization.

◆ STREAMING_ENGINE_PLAYBACK_FLAG_DISABLE_FIXED_PREROLL_TIME

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_PLAYBACK_FLAG_DISABLE_FIXED_PREROLL_TIME = 16
static

Decreases the first frame lag of playback engine.

◆ STREAMING_ENGINE_PLAYBACK_FLAG_DISABLE_PRELOADER_ON_SOURCE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_PLAYBACK_FLAG_DISABLE_PRELOADER_ON_SOURCE = 64
static

disable preloader on video source

◆ STREAMING_ENGINE_PLAYBACK_FLAG_LOW_PIPELINE_SIZE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_PLAYBACK_FLAG_LOW_PIPELINE_SIZE = 8
static

Decreases the pipeline size of playback engine.

◆ STREAMING_ENGINE_PLAYBACK_FLAG_SPEED_COMP_MODE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_PLAYBACK_FLAG_SPEED_COMP_MODE = 512
static

Playback with speed compensation.

◆ STREAMING_ENGINE_PLAYBACK_FLAG_VARIABLE_FRAME_RATE_ENABLE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_PLAYBACK_FLAG_VARIABLE_FRAME_RATE_ENABLE = 4096
static

Enable variable frame rate playback, and the playback frame rate will change with the video frame rate.

◆ STREAMING_ENGINE_RECORDING_FLAG_DISABLE_HARDWARE_ENCODER

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_RECORDING_FLAG_DISABLE_HARDWARE_ENCODER = 4
static

Records without hardware encoder.

◆ STREAMING_ENGINE_RECORDING_FLAG_DISABLE_MEDIA_MUXER

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_RECORDING_FLAG_DISABLE_MEDIA_MUXER = 128
static

disable MediaMuxer

◆ STREAMING_ENGINE_RECORDING_FLAG_DONT_USE_INPUT_SURFACE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_RECORDING_FLAG_DONT_USE_INPUT_SURFACE = 64
static

Does not use input surface.

◆ STREAMING_ENGINE_RECORDING_FLAG_FLIP_HORIZONTALLY

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_RECORDING_FLAG_FLIP_HORIZONTALLY = 512
static

Flip horizontally input video frame.

◆ STREAMING_ENGINE_RECORDING_FLAG_IGNORE_VIDEO_ROTATION

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_RECORDING_FLAG_IGNORE_VIDEO_ROTATION = 32
static

Video recorded is not rotated according to the capture device's orientation. (Note: only workds with STREAMING_ENGINE_CAPTURE_FLAG_DONT_USE_SYSTEM_RECORDER)

◆ STREAMING_ENGINE_RECORDING_FLAG_ONLY_RECORD_VIDEO

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_RECORDING_FLAG_ONLY_RECORD_VIDEO = 16
static

Only records video streams to file, all audio streams would not be recorded.

◆ STREAMING_ENGINE_RECORDING_FLAG_RECORDING_WITHOUT_FX

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_RECORDING_FLAG_RECORDING_WITHOUT_FX = 256
static

recording without fx, Remarkļ¼šit has only effects when using the flags of STREAMING_ENGINE_CAPTURE_FLAG_DONT_USE_SYSTEM_RECORDER

◆ STREAMING_ENGINE_RECORDING_FLAG_SOFTWARE_VIDEO_INTRA_FRAME_ONLY_FAST_STOP

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_RECORDING_FLAG_SOFTWARE_VIDEO_INTRA_FRAME_ONLY_FAST_STOP = 8
static

Fast stop when recording I-Frame-only video with software encoder, this could result in a discard of video frame.

◆ STREAMING_ENGINE_RECORDING_FLAG_VIDEO_INTRA_FRAME_ONLY

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_RECORDING_FLAG_VIDEO_INTRA_FRAME_ONLY = 2
static

Records files that only include I-Frame. (Note: only works when using with STREAMING_ENGINE_CAPTURE_FLAG_DONT_USE_SYSTEM_RECORDER)

◆ STREAMING_ENGINE_SEEK_FLAG_BUDDY_HOST_VIDEO_FRAME

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_SEEK_FLAG_BUDDY_HOST_VIDEO_FRAME = 16
static

buddy video frame in host, used to detect face

◆ STREAMING_ENGINE_SEEK_FLAG_BUDDY_ORIGIN_VIDEO_FRAME

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_SEEK_FLAG_BUDDY_ORIGIN_VIDEO_FRAME = 256
static

buddy video frame in host after decoding, used to detect face

◆ STREAMING_ENGINE_SEEK_FLAG_NOT_CONNECT_TO_LIVEWINDOW

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_SEEK_FLAG_NOT_CONNECT_TO_LIVEWINDOW = 128
static

Seek can be done without connecting to the LiveWindow.

◆ STREAMING_ENGINE_SEEK_FLAG_SHOW_ANIMATED_STICKER_POSTER

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_SEEK_FLAG_SHOW_ANIMATED_STICKER_POSTER = 4
static

Shows the entire animated sticker effects.

◆ STREAMING_ENGINE_SEEK_FLAG_SHOW_CAPTION_POSTER

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_SEEK_FLAG_SHOW_CAPTION_POSTER = 2
static

Shows the entire caption effects.

◆ STREAMING_ENGINE_SEND_BUFFER_FLAG_ONLY_FOR_BUDDY

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_SEND_BUFFER_FLAG_ONLY_FOR_BUDDY = 2
static

Data only used for handeling buddy video captured's frame content.

◆ STREAMING_ENGINE_SEND_BUFFER_FLAG_ONLY_FOR_GRAB

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_SEND_BUFFER_FLAG_ONLY_FOR_GRAB = 1
static

◆ STREAMING_ENGINE_STATE_CAPTUREPREVIEW

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_STATE_CAPTUREPREVIEW = 1
static

Capture preview.

◆ STREAMING_ENGINE_STATE_CAPTURERECORDING

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_STATE_CAPTURERECORDING = 2
static

Capture recording.

◆ STREAMING_ENGINE_STATE_COMPILE

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_STATE_COMPILE = 5
static

Compiling file.

◆ STREAMING_ENGINE_STATE_PLAYBACK

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_STATE_PLAYBACK = 3
static

Playback.

◆ STREAMING_ENGINE_STATE_SEEKING

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_STATE_SEEKING = 4
static

Seeking.

◆ STREAMING_ENGINE_STATE_STOPPED

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_STATE_STOPPED = 0
static

Engine stopped.

◆ STREAMING_ENGINE_STOP_FLAG_ASYNC

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_STOP_FLAG_ASYNC = 2
static

Stops the engine asynchronously to avoid blocking main thread.

◆ STREAMING_ENGINE_STOP_FLAG_FORCE_STOP_COMPILATION

final int com.meicam.sdk.NvsStreamingContext.STREAMING_ENGINE_STOP_FLAG_FORCE_STOP_COMPILATION = 1
static

Forces stop of compilation, resulting compiled file incomplete.

◆ VIDEO_CAPTURE_RESOLUTION_GRADE_EXTREMELY_HIGH

final int com.meicam.sdk.NvsStreamingContext.VIDEO_CAPTURE_RESOLUTION_GRADE_EXTREMELY_HIGH = 4
static

Extremely high resolution for video capture.

◆ VIDEO_CAPTURE_RESOLUTION_GRADE_HIGH

final int com.meicam.sdk.NvsStreamingContext.VIDEO_CAPTURE_RESOLUTION_GRADE_HIGH = 2
static

High resolution for video capture.

◆ VIDEO_CAPTURE_RESOLUTION_GRADE_LOW

final int com.meicam.sdk.NvsStreamingContext.VIDEO_CAPTURE_RESOLUTION_GRADE_LOW = 0
static

Low resolution for video capture.

◆ VIDEO_CAPTURE_RESOLUTION_GRADE_MEDIUM

final int com.meicam.sdk.NvsStreamingContext.VIDEO_CAPTURE_RESOLUTION_GRADE_MEDIUM = 1
static

Medium resolution for video capture.

◆ VIDEO_CAPTURE_RESOLUTION_GRADE_SUPER_HIGH

final int com.meicam.sdk.NvsStreamingContext.VIDEO_CAPTURE_RESOLUTION_GRADE_SUPER_HIGH = 3
static

Super high resolution for video capture.

◆ VIDEO_ENCODEC_NAME

final String com.meicam.sdk.NvsStreamingContext.VIDEO_ENCODEC_NAME = "video encoder name"
static

Assigned video encoding format, hevc(h.256) is supported, default is h.264.

◆ VIDEO_FRAME_RECEIVER_FLAG_FORCE_RGBA_FORMAT

final int com.meicam.sdk.NvsStreamingContext.VIDEO_FRAME_RECEIVER_FLAG_FORCE_RGBA_FORMAT = 1
static

Force RGBA pixel format on output buffer.

◆ VIDEO_PREVIEW_SIZEMODE_FULLSIZE

final int com.meicam.sdk.NvsStreamingContext.VIDEO_PREVIEW_SIZEMODE_FULLSIZE = 0
static

Full-screen preview mode.

◆ VIDEO_PREVIEW_SIZEMODE_LIVEWINDOW_SIZE

final int com.meicam.sdk.NvsStreamingContext.VIDEO_PREVIEW_SIZEMODE_LIVEWINDOW_SIZE = 1
static

Livewindow size preview mode.

◆ VIDEO_STABILIZATION_MODE_AUTO

final int com.meicam.sdk.NvsStreamingContext.VIDEO_STABILIZATION_MODE_AUTO = 1
static

Sets on/off of the video stabilization mode to auto.

◆ VIDEO_STABILIZATION_MODE_OFF

final int com.meicam.sdk.NvsStreamingContext.VIDEO_STABILIZATION_MODE_OFF = 0
static

Turns off the video anti-shake mode.

◆ VIDEO_STABILIZATION_MODE_STANDARD

final int com.meicam.sdk.NvsStreamingContext.VIDEO_STABILIZATION_MODE_STANDARD = 2
static

Standard mode for video anti-shake mode.

◆ VIDEO_STABILIZATION_MODE_SUPER

final int com.meicam.sdk.NvsStreamingContext.VIDEO_STABILIZATION_MODE_SUPER = 3
static

Anti-shake movie mode.


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