5.3. API Reference¶

Video Output (VO) implementVideo OutputDevice, Video, Channeletc.Function.

thisFunctionModuletheSupport API, withunderbywhilefromDevice, Video layer, Channeletc.surfaceperform

DeviceRelatedAPI as follows:

CVI_VO_Enable: EnableVideo OutputDevice.
CVI_VO_Disable: DisableVideo OutputDevice.
CVI_VO_IsEnabled: QueryOutputDeviceWhetheralready enabled.
CVI_VO_SetPubAttr: SetVideo OutputDeviceRelatedAttribute.
CVI_VO_GetPubAttr: GetVideo OutputDeviceRelatedAttribute.
CVI_VO_CloseFd: CloseVideo OutputDeviceFilehandle.
CVI_VO_Suspend: currentlyDisplayDevice.
CVI_VO_Resume: resumeDisplayDevice.

InterfaceRelatedAPIas follows:

CVI_VO_SetBTParam: SetDeviceBTInterfaceAttribute.
CVI_VO_GetBTParam: GetDeviceBTInterfaceAttribute.
CVI_VO_SetLVDSParam: SetDeviceLVDSInterfaceAttribute.
CVI_VO_GetLVDSParam: GetDeviceLVDSInterfaceAttribute.

Video layerRelatedAPIas follows:

CVI_VO_EnableVideoLayer: EnableVideo layer.
CVI_VO_DisableVideoLayer: DisableVideo layer.
CVI_VO_SetVideoLayerAttr: SetVideo layerRelatedAttribute.
CVI_VO_GetVideoLayerAttr: GetVideo layerRelatedAttribute.
CVI_VO_GetLayerProcAmpCtrl: GetVideo layerImageeffectiveFunctionDescription.
CVI_VO_SetLayerProcAmp: SetVideo layerImageeffectiveAttribute.
CVI_VO_GetLayerProcAmp: GetVideo layerImageeffectiveAttribute.
CVI_VO_SetDisplayBufLen: SetVideoDisplayBufferLength.
CVI_VO_GetDisplayBufLen: GetVideoDisplayBufferLength.

ChannelRelatedAPI as follows:

CVI_VO_EnableChn: EnableVideo OutputChannel.
CVI_VO_DisableChn: DisableVideo OutputChannel.
CVI_VO_SetChnAttr: SetVideo OutputChannelRelatedAttribute.
CVI_VO_GetChnAttr: GetVideo OutputChannelRelatedAttribute.
CVI_VO_ShowChn: DisplayspecifiedVideo OutputChannel.
CVI_VO_HideChn: hidespecifiedVideo OutputChannel.
CVI_VO_SetChnRotation: SetVideo OutputChannelRotationAttribute.
CVI_VO_GetChnRotation: GetVideo OutputChannelRotationAttribute.
CVI_VO_PauseChn: currentlyspecifiedVOChannelOutput.
CVI_VO_ResumeChn: resumespecified VOChannelOutput.
CVI_VO_ClearChnBuf: emptyspecifiedVideo layerspecifiedChannelVideoBuffer.
CVI_VO_SendFrame: tospecifiedVideo layerspecifiedChannelSendVideoFrame.
CVI_VO_SetChnFrameRate: SetspecifiedVideo OutputChannelDisplayFrame rate.
CVI_VO_GetChnFrameRate: GetspecifiedVideo OutputChannelDisplayFrame rate.
CVI_VO_GetChnPTS: GetspecifiedVideo OutputChannelcurrentDisplayImageTimestamp.
CVI_VO_QueryChnStatus: QueryVideo OutputChannelStatus.

otherAPIas follows:

CVI_VO_Get_Panel_Status: GetDisplaysurfaceStatus.
CVI_VO_RegPmCallBack: registerelectricalsourcecallbackFunction.
CVI_VO_UnRegPmCallBack: cancelregisterelectricalsourcecallbackFunction.
CVI_VO_SetGammaInfo: Set gamma correction information.
CVI_VO_GetGammaInfo: GetcorrectionInformation.
CVI_VO_ShowPattern: inDeviceonDisplayFigureexample.

5.3.1. CVI_VO_Enable¶

Description

EnableVideo OutputDevice.

Syntax

CVI_S32 CVI_VO_Enable(VO_DEV VoDev); 

Parameters

Parameter Name

Description

Input/Output

VoDev

Video output device number.

Value range: [0, VO_MAX_DEV_NUM].

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

mustinUseVideo OutputFunctionbeforefirstperform DeviceEnableoperation.
inCallDeviceEnablebefore, mustforDevicecommonAttributeperform Configuration, otherwise, it returnsDevicenot configuredError.
If change VO timingConfiguration, thenneed tofirstCall CVI_VO_Disable Interface, Close VO HardwareafterthenEnable. withmoretimingprocessinappearnottime.

Example

 CVI_S32 s32Ret = CVI_SUCCESS; s32Ret = CVI_VO_SetPubAttr(VoDev, pstPubAttr); if (s32Ret != CVI_SUCCESS) {  SAMPLE_PRT("failed with %#x!\n", s32Ret);  return CVI_FAILURE; } s32Ret = CVI_VO_Enable(VoDev); if (s32Ret != CVI_SUCCESS) {  SAMPLE_PRT("failed with %#x!\n", s32Ret);  return CVI_FAILURE; } 

Related Topics

CVI_VO_Disable

5.3.2. CVI_VO_Disable¶

Description

DisableVideo OutputDevice.

Syntax

CVI_S32 CVI_VO_Disable(VO_DEV VoDev); 

Parameters

Parameter Name

Description

Input/Output

VoDev

Video output device number.

Value range: [0, VO_MAX_DEV_NUM].

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Deviceprohibitbeforemust firstprohibitthisDeviceonVideo layer.
onlyhasinVO Deviceprohibitunder, canperformSetDevice attributesmore.

Example

None

Related Topics

CVI_VO_Enable

5.3.3. CVI_VO_IsEnabled¶

Description

QueryOutputDeviceWhetheralready enabled.

Syntax

CVI_BOOL CVI_VO_IsEnabled(VO_DEV VoDev); 

Parameters

Parameter Name

Description

Input/Output

VoDev

Video output device number.

Value range: [0, VO_MAX_DEV_NUM].

Input

Return Value

Return Value	Description
Non-zero	Success.
0	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

inexecute CVI_VO_Enable afterCall.

Example

None

Related Topics

CVI_VO_Enable

CVI_VO_Disable

5.3.4. CVI_VO_Suspend¶

Description

DisplayDeviceinStatus.

Syntax

CVI_S32 CVI_VO_Suspend(void); 

Return Value

Return Value	Description
Non-zero	Success.
0	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

inexecute CVI_VO_Enable afterCall.

Example

None

Related Topics

None

5.3.5. CVI_VO_Resume¶

Description

DisplayDeviceresumenormalStatus.

Syntax

CVI_S32 CVI_VO_Resume(void); 

Return Value

Return Value	Description
Non-zero	Success.
0	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

Related Topics

None

5.3.6. CVI_VO_SetPubAttr¶

Description

ConfigurationVideo OutputDeviceRelatedAttribute.

Syntax

CVI_S32 CVI_VO_SetPubAttr(VO_DEV VoDev, const VO_PUB_ATTR_S *pstPubAttr); 

Parameters

Parameter Name

Description

Input/Output

VoDev

Video output device number.

Value range: [0, VO_MAX_DEV_NUM].

Input

pstPubAttr

Video Output device public attribute structure pointer.

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Video OutputDevice attributesisstaticAttribute, must inexecute CVI_VO_Enable before Configuration.
eachDEV UseDescriptionSee VO_DEV.
Video OutputDevice attributesUseDescriptionSee VO_PUB_ATTR_S section.

Example

None

Related Topics

CVI_VO_GetPubAttr

5.3.7. CVI_VO_GetPubAttr¶

Description

GetVideo OutputDeviceRelatedAttribute.

Syntax

CVI_S32 CVI_VO_GetPubAttr(VO_DEV VoDev, VO_PUB_ATTR_S *pstPubAttr); 

Parameters

Parameter Name

Description

Input/Output

VoDev

Video output device number.

Value range: [0, VO_MAX_DEV_NUM].

Input

pstPubAttr

Video Output device public attribute structure pointer.

Output

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

inSetDevicecommonAttributebeforefirstGetAttribute, canonlySetneed to Configuration.

Example

None

Related Topics

CVI_VO_SetPubAttr

5.3.8. CVI_VO_SetBTParam¶

Description

SetDeviceBTInterfaceAttribute.

Syntax

CVI_S32 CVI_VO_SetBTParam(VO_DEV VoDev, const VO_BT_ATTR_S *pstBTParam); 

Parameters

Parameter Name

Description

Input/Output

VoDev

Video output device number.

Value range: [0, VO_MAX_DEV_NUM].

Input

pstBTParam

BTInterfaceAttribute StructurebodyPointer.

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Failure is returned when the device interface is not configured as BT.
thisInterfaceNot supporteddynamicSet, SetBTInterfaceAttributetime, need toinexecute CVI_VO_SetPubAttr After setting the device public attributes, configure and execute CVI_VO_Enable before Configuration.

Example

None

Related Topics

CVI_VO_GetBTParam

5.3.9. CVI_VO_GetBTParam¶

Description

GetDeviceBTInterfaceAttribute.

Syntax

CVI_S32 CVI_VO_GetBTParam(VO_DEV VoDev, VO_BT_ATTR_S *pstBTParam); 

Parameters

Parameter Name

Description

Input/Output

VoDev

Video output device number.

Value range: [0, VO_MAX_DEV_NUM].

Input

pstBTParam

BTInterfaceAttribute StructurebodyPointer.

Output

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Failure is returned when the device interface is not configured as BT.

Example

None

Related Topics

CVI_VO_SetBTParam

5.3.10. CVI_VO_SetLVDSParam¶

Description

SetDeviceLVDSInterfaceOutputAttribute.

Syntax

CVI_S32 CVI_VO_SetLVDSParam(VO_DEV VoDev, const VO_LVDS_ATTR_S *pstLVDSParam); 

Parameters

Parameter Name

Description

Input/Output

VoDev

Video output device number.

Value range: [0, VO_MAX_DEV_NUM].

Input

pstLVDSParam

LVDS interface attribute structure pointer.

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Failure is returned when the device interface is not configured as LVDS.
thisInterfaceNot supporteddynamicSet, SetLVDSInterfaceAttributetime, need toinexecute CVI_VO_SetPubAttr After setting the device public attributes, configure and execute CVI_VO_Enable before Configuration.

Example

None

Related Topics

CVI_VO_GetLVDSParam

5.3.11. CVI_VO_GetLVDSParam¶

Description

GetDeviceLVDSInterfaceOutputAttribute.

Syntax

CVI_S32 CVI_VO_GetLVDSParam(VO_DEV VoDev, VO_LVDS_ATTR_S *pstLVDSParam); 

Parameters

Parameter Name

Description

Input/Output

VoDev

Video output device number.

Value range: [0, VO_MAX_DEV_NUM].

Input

pstLVDSParam

LVDS interface attribute structure pointer.

Output

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Failure is returned when the device interface is not configured as LVDS.

Example

None

Related Topics

CVI_VO_SetLVDSParam

5.3.12. CVI_VO_EnableVideoLayer¶

Description

EnableVideo layer.

Syntax

CVI_S32 CVI_VO_EnableVideoLayer (VO_LAYER VoLayer); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Video layerEnablebeforemust ensurethisVideo layertheBindDevicetoEnableStatus.

Example

None

Related Topics

CVI_VO_DisableVideoLayer

5.3.13. CVI_VO_DisableVideoLayer¶

Description

DisableVideo layer.

Syntax

CVI_S32 CVI_VO_DisableVideoLayer (VO_LAYER VoLayer); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Video layerprohibitbefore, itsonChannelmust firstprohibit.

Example

None

Related Topics

CVI_VO_EnableVideoLayer

5.3.14. CVI_VO_SetVideoLayerAttr¶

Description

ConfigurationVideo layerRelatedAttribute.

Syntax

CVI_S32 CVI_VO_SetVideoLayerAttr (VO_LAYER VoLayer, const VO_VIDEO_LAYER_ATTR_S *pstLayerAttr); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

pstLayerAttr

Video layer attribute structure pointer.

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

Related Topics

CVI_VO_GetVideoLayerAttr

5.3.15. CVI_VO_GetVideoLayerAttr¶

Description

GetVideo layerRelatedAttribute.

Syntax

CVI_S32 CVI_VO_GetVideoLayerAttr (VO_LAYER VoLayer, VO_VIDEO_LAYER_ATTR_S *pstLayerAttr); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

pstLayerAttr

Video layer attribute structure pointer.

Output

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

Related Topics

CVI_VO_SetVideoLayerAttr

5.3.16. CVI_VO_GetLayerProcAmpCtrl¶

Description

GetVideo layerImageeffectiveControlParameter.

Syntax

CVI_S32 CVI_VO_GetLayerProcAmpCtrl(VO_LAYER VoLayer, PROC_AMP_E type, PROC_AMP_CTRL_S *ctrl); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

type

Video layer image effect type.

Input

ctrl

Video layerImageeffectiveControlParameterStructurePointer.

Output

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

thisInterfacemainused to GetVideo layerImageeffective, includingBrightness, Contrast, hue, SaturationValue Range, step, anddefault value.

Example

None

Related Topics

CVI_VO_GetLayerProcAmp

CVI_VO_SetLayerProcAmp

5.3.17. CVI_VO_SetLayerProcAmp¶

Description

SetVideo layerImageeffectiveAttribute.

Syntax

CVI_S32 CVI_VO_SetLayerProcAmp(VO_LAYER VoLayer, PROC_AMP_E type, CVI_S32 value); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

type

Video layer image effect type.

Input

value

ImageeffectiveParametervalue.

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

thisInterfacemainused to SetVideo layerImageeffective, includingBrightness, Contrast, hue, Saturation.
Brightness, Contrast, SaturationValue Range[0, 255], hueValue Range[0, 359].
The interface cannot be called before the video layer is started.

Example

None

Related Topics

CVI_VO_GetLayerProcAmpCtrl

CVI_VO_GetLayerProcAmp

5.3.18. CVI_VO_GetLayerProcAmp¶

Description

GetVideo layerImageeffectiveAttribute.

Syntax

CVI_S32 CVI_VO_GetLayerProcAmp(VO_LAYER VoLayer, PROC_AMP_E type, CVI_S32 *value); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

type

Video layer image effect type.

Input

value

ImageeffectiveParametervaluevariablePointer.

Output

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

thisInterfacemainused to GetVideo layerImageeffective, includingBrightness, Contrast, hue, Saturation.
The interface cannot be called before the video layer is started.

Example

None

Related Topics

CVI_VO_GetLayerProcAmpCtrl

CVI_VO_SetLayerProcAmp

5.3.19. CVI_VO_SetDisplayBufLen¶

Description

SetVideoDisplayBufferLength.

Syntax

CVI_S32 CVI_VO_SetDisplayBufLen(VO_LAYER VoLayer, CVI_U32 u32BufLen); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

u32BufLen

VideoDisplayBufferLength.

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Callbeforeneed toVideo layernot enabled, otherwiseInvalid.

Example

None

Related Topics

CVI_VO_GetDisplayBufLen

5.3.20. CVI_VO_GetDisplayBufLen¶

Description

GetVideoDisplayBufferLength.

Syntax

CVI_S32 CVI_VO_GetDisplayBufLen(VO_LAYER VoLayer, CVI_U32 *pu32BufLen); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

u32BufLen

VideoDisplayBufferLength.

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

Related Topics

CVI_VO_SetDisplayBufLen

5.3.21. CVI_VO_EnableChn¶

Description

EnablespecifiedVideo OutputChannel.

Syntax

CVI_S32 CVI_VO_EnableChn(VO_LAYER VoLayer, VO_CHN VoChn); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

CallbeforemustEnableshouldDeviceonVideo layer.
ChannelEnablebeforemustperform ChannelConfiguration, otherwise, it returnsChannelnot configuredError.

Example

None

Related Topics

CVI_VO_DisableChn

5.3.22. CVI_VO_DisableChn¶

Description

DisableVideo OutputChannel.

Syntax

CVI_S32 CVI_VO_DisableChn(VO_LAYER VoLayer, VO_CHN VoChn); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

Related Topics

CVI_VO_EnableChn

5.3.23. CVI_VO_SetChnAttr¶

Description

ConfigurationVideo OutputChannelRelatedAttribute.

Syntax

CVI_S32 CVI_VO_SetPubAttr(VO_LAYER VoLayer, VO_CHN VoChn, const VO_CHN_ATTR_S *pstChnAttr); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

pstChnAttr

Video Output channel attribute structure pointer.

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

ChannelDisplayRegionneed toless thanVideo layerAttributeMediumSetstImageSize Size.

Example

None

Related Topics

CVI_VO_GetChnAttr

5.3.24. CVI_VO_GetChnAttr¶

Description

GetVideo OutputChannelRelatedAttribute.

Syntax

CVI_S32 CVI_VO_GtPubAttr(VO_LAYER VoLayer, VO_CHN VoChn, VO_CHN_ATTR_S *pstChnAttr); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

pstChnAttr

Video Output channel attribute structure pointer.

Output

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

Related Topics

CVI_VO_SetChnAttr

5.3.25. CVI_VO_ShowChn¶

Description

DisplayspecifiedVideo OutputChannel.

Syntax

CVI_S32 CVI_VO_ShowChn(VO_LAYER VoLayer, VO_CHN VoChn); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

The video channel on the corresponding device must be enabled before calling.
defaultundertoDisplayStatus.

Example

None

Related Topics

CVI_VO_HideChn

5.3.26. CVI_VO_HideChn¶

Description

hidespecifiedVideo OutputChannel.

Syntax

CVI_S32 CVI_VO_HideChn(VO_LAYER VoLayer, VO_CHN VoChn); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

Related Topics

CVI_VO_ShowChn

5.3.27. CVI_VO_SetChnRotation¶

Description

Set VOChannelRotationAttribute.

Syntax

CVI_S32 CVI_VO_SetChnRotation(VO_LAYER VoLayer, VO_CHN VoChn, ROTATION_E enRotation); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

enRotation

RotationAttribute. See ROTATION_E Description

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Before using this interface, call CVI_VO_SetChnAttr, otherwise, it reportsFailure.
CV184xonlySupportNV12, NV21andYUV400threeFormatRotation.
Setafter, Rotationwillused to inChannelVideoImage, NoteSetVideo layerandVideoChannelAttributeSize. For exampleChannelSetSizeis1920x1080, andRotation90, thereforeInputgiveChannelImageshouldis1080x1920.

Example

None

Related Topics

None

5.3.28. CVI_VO_GetChnRotation¶

Description

Get VOChannelRotationAttribute.

Syntax

CVI_S32 CVI_VO_GetChnRotation(VO_LAYER VoLayer, VO_CHN VoChn, ROTATION_E *penRotation); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

penRotation

RotationAttributePointer. See ROTATION_E Description

Output

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Before using this interface, call CVI_VO_SetChnAttr, otherwise, it reportsFailure.

Example

None

Related Topics

CVI_VO_SetChnRotation

5.3.29. CVI_VO_PauseChn¶

Description

currentlyspecifiedVOChannelOutput.

Syntax

CVI_S32 CVI_VO_PauseChn(VO_LAYER VoLayer, VO_CHN VoChn); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

The video channel on the corresponding device must be enabled before calling.
repeatcurrentlysameoneChannel, notReturnFailure.

Example

None

Related Topics

CVI_VO_ResumeChn

5.3.30. CVI_VO_ResumeChn¶

Description

resumespecified VOChannelOutput.

Syntax

CVI_S32 CVI_VO_ResumeChn(VO_LAYER VoLayer, VO_CHN VoChn); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

The video channel on the corresponding device must be enabled before calling.
repeatresumesameoneChannel, notReturnFailure.

Example

None

Related Topics

CVI_VO_PauseChn

5.3.31. CVI_VO_ClearChnBuf¶

Description

emptyspecifiedVideo layerspecifiedChannelVideoBuffer.

Syntax

CVI_S32 CVI_VO_ClearChnBuf(VO_LAYER VoLayer, VO_CHN VoChn, CVI_BOOL bClrAll); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

bClrAll

Whetherallempty.

CVI_TRUE: willChannelinDataallempty, thistime onthisChannelRegionwillNoneImageDisplay, tohasFigure Datatoto.

CVI_FALSE: inChannelinretainoneFrameImageData, whilewillotherDataempty.

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

5.3.32. CVI_VO_SendFrame¶

Description

tospecifiedVideo layerspecifiedChannelSendVideoFrame.

Syntax

CVI_S32 CVI_VO_SendFrame(VO_LAYER VoLayer, VO_CHN VoChn, VIDEO_FRAME_INFO_S *pstVideoFrame, CVI_S32 s32MilliSec); 

Parameters

Parameter Name	Description	Input/Output
VoLayer	Video output video layer number. Value range: [0, VO_MAX_LAYER_NUM].	Input
VoChn	Video output channel number. Value range: [0, VO_MAX_CHN_NUM].	Input
pstVideoFrame	VideoFrameInformationStructurePointer.	Input
s32MilliSec	VideoFrameSendafteretc.pendingtime.	Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Ensure that the channel is enabled before calling this interface.
blockingformSendcurrentlyNot supported, s32MilliSecNone.
InputVideoDataInformationdescriptorcombinedVODatarequire.

Example

None

Related Topics

None

5.3.33. CVI_VO_SetChnFrameRate¶

Description

SetspecifiedVideo OutputChannelDisplayFrame rate.

Syntax

CVI_S32 CVI_VO_SetChnFrameRate(VO_LAYER VoLayer, VO_CHN VoChn, CVI_S32 s32ChnFrmRate); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

s32ChnFrmRate

Video OutputChannelFrame rate.

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Ensure that the channel is enabled before calling this interface.
SetFrame ratenotcangreater thancurrentChannelactualFrame rate.

Example

None

Related Topics

CVI_VO_GetChnFrameRate

5.3.34. CVI_VO_GetChnFrameRate¶

Description

GetspecifiedVideo OutputChannelDisplayFrame rate.

Syntax

CVI_S32 CVI_VO_GetChnFrameRate(VO_LAYER VoLayer, VO_CHN VoChn, CVI_S32 *ps32ChnFrmRate); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

ps32ChnFrmRate

Video OutputChannelFrame ratevariablePointer.

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

ReturnChannelactualFrame rate.

Example

None

Related Topics

CVI_VO_SetChnFrameRate

5.3.35. CVI_VO_GetChnPTS¶

Description

GetspecifiedVideo OutputChannelcurrentDisplayImageTimestamp.

Syntax

CVI_S32 CVI_VO_GetChnPTS(VO_LAYER VoLayer, VO_CHN VoChn, CVI_U64 *pu64ChnPTS); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

pu64ChnPTS

Video OutputChannelTimestampvariablePointer.

Output

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Callbeforeneed toVideo layerEnable, VideoChannelEnable.

Example

None

Related Topics

None

5.3.36. CVI_VO_QueryChnStatus¶

Description

QueryVideo OutputChannelStatus.

Syntax

CVI_S32 CVI_VO_QueryChnStatus(VO_LAYER VoLayer, VO_CHN VoChn, VO_QUERY_STATUS_S *pstStatus); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

pstStatus

ChannelStatusStructurePointer.

Output

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

Callbeforeneed toVideoDeviceEnable.
Callbeforeneed totheQueryChannelalready enabled.
canmultiplesecondaryCallGetChannelStatusInterface.

Example

None

Related Topics

None

5.3.37. CVI_VO_CloseFd¶

Description

CloseVideo OutputDeviceFilehandle.

Syntax

CVI_S32 CVI_VO_CloseFd(CVI_VOID); 

Parameters

None

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

thisInterfaceCallafter, VOother MMFInterfaceeffective.

Example

None

Related Topics

None

5.3.38. CVI_VO_Get_Panel_Status¶

Description

CloseVideo OutputDeviceFilehandle.

Syntax

CVI_S32 CVI_VO_Get_Panel_Status(VO_LAYER VoLayer, VO_CHN VoChn, CVI_U32 *is_init); 

Parameters

Parameter Name

Description

Input/Output

VoLayer

Video output video layer number.

Value range: [0, VO_MAX_LAYER_NUM].

Input

VoChn

Video output channel number.

Value range: [0, VO_MAX_CHN_NUM].

Input

is_init

DisplaysurfaceWhetherInitialize.

Output

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

Related Topics

None

5.3.39. CVI_VO_RegPmCallBack¶

Description

registerelectricalsourcecallbackFunction.

Syntax

CVI_S32 CVI_VO_RegPmCallBack(VO_DEV VoDev, VO_PM_OPS_S *pstPmOps, void *pvData) 

Parameters

Parameter Name

Description

Input/Output

VoDev

Video output device number.

Value range: [0, VO_MAX_DEV_NUM].

Input

pstPmOps

electricalsourcenumberStructurePointer.

Input

pvData

outsideUserDataPointer.

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

Related Topics

CVI_VO_UnRegPmCallBack

5.3.40. CVI_VO_UnRegPmCallBack¶

Description

cancelregisterelectricalsourcecallbackFunction.

Syntax

CVI_S32 CVI_VO_UnRegPmCallBack(VO_DEV VoDev);) 

Parameters

Parameter Name

Description

Input/Output

VoDev

Video output device number.

Value range: [0, VO_MAX_DEV_NUM].

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

Related Topics

CVI_VO_RegPmCallBack

5.3.41. CVI_VO_SetGammaInfo¶

Description

Set gamma correction information.

Syntax

CVI_S32 CVI_VO_SetGammaInfo(VO_GAMMA_INFO_S *pinfo); 

Parameters

Parameter Name	Description	Input/Output
pinfo	Gamma correction information structure pointer.	Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

Related Topics

CVI_VO_GetGammaInfo

5.3.42. CVI_VO_GetGammaInfo¶

Description

Set gamma correction information.

Syntax

CVI_S32 CVI_VO_GetGammaInfo(VO_GAMMA_INFO_S *pinfo); 

Parameters

Parameter Name	Description	Input/Output
pinfo	Gamma correction information structure pointer.	Output

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

None

Example

None

Related Topics

CVI_VO_SetGammaInfo

5.3.43. CVI_VO_ShowPattern¶

Description

Set gamma correction information.

Syntax

CVI_S32 CVI_VO_ShowPattern(VO_DEV VoDev, enum VO_PATTERN_MODE PatternId); 

Parameters

Parameter Name

Description

Input/Output

VoDev

Video output device number.

Value range: [0, VO_MAX_DEV_NUM].

Input

VO_PATTERN_MODE

FigureexampleoperationcommandID

Input

Return Value

Return Value	Description
0	Success.
Non-zero	Failure; see Error Codes.

Requirements

Header files: cvi_vo.h, cvi_comm_vo.h
Library files: libvo.a

Note

thisInterfaceused to debugtimeOutputinsettest pattern

Example

None

Related Topics

None