TV

Collaboration diagram for TV:

Typedefs
typedef enum AVMTvAspectRatio	AVMTvAspectRatio
typedef enum AVMTvResolution	AVMTvResolution
typedef enum AVMTvVideoRegion	AVMTvVideoRegion

Enumerations
enum	AVMTvAspectRatio {   AVM_TV_ASPECT_RATIO_4_3 ,   AVM_TV_ASPECT_RATIO_16_9 }
enum	AVMTvResolution {   AVM_TV_RESOLUTION_576I = 1 ,   AVM_TV_RESOLUTION_480I = 2 ,   AVM_TV_RESOLUTION_480P = 3 ,   AVM_TV_RESOLUTION_720P = 4 ,   AVM_TV_RESOLUTION_720P_3D = 5 ,   AVM_TV_RESOLUTION_1080I = 6 ,   AVM_TV_RESOLUTION_1080P = 7 ,   AVM_TV_RESOLUTION_480I_PAL60 = 10 ,   AVM_TV_RESOLUTION_576P = 11 ,   AVM_TV_RESOLUTION_720P_50HZ = 12 ,   AVM_TV_RESOLUTION_1080I_50HZ = 13 ,   AVM_TV_RESOLUTION_1080P_50HZ = 14 }
enum	AVMTvVideoRegion {   AVM_TV_VIDEO_REGION_NTSC = 1 ,   AVM_TV_VIDEO_REGION_PAL }

Functions
BOOL	AVMDebugIsNTSC (void)
	Gets the TV video region. More...
BOOL	AVMGetCurrentPort (TVEPort *outPort)
	Gets the TV port. More...
void	AVMGetHDMIState (TVEHdmiState *outState)
	Gets the HDMI state. More...
BOOL	AVMGetTVAspectRatio (AVMTvAspectRatio *outAspectRatio)
	Gets the TV aspect ratio. More...
BOOL	AVMGetTVScanMode (AVMTvResolution *outResolution)
	Gets the TV resolution. More...
int32_t	AVMGetTVUnderScan (uint32_t *outUnderScan)
	Gets the TV under scan. More...
BOOL	AVMIsAVOutReady (void)
	Determines whether a TV is currently connected and displaying the Wii U source. More...
BOOL	AVMSetTVAspectRatio (AVMTvAspectRatio aspectRatio)
	Sets the TV aspect ratio. More...
BOOL	AVMSetTVEnable (BOOL enable)
	Sets whether to show or hide the TV video out. More...
int32_t	AVMSetTVOutPort (TVEPort port, AVMTvResolution resolution)
	Sets the TV port. More...
int32_t	AVMSetTVScanMode (AVMTvResolution resolution, uint32_t unknown, TVEPort port)
	Sets the TV resolution and port. More...
int32_t	AVMSetTVScanResolution (AVMTvResolution resolution)
	Sets the TV resolution. More...
int32_t	AVMSetTVUnderScan (uint32_t underScan)
	Sets the TV under scan. More...
int32_t	AVMSetTVUnderScanParam (uint32_t underScan)
int32_t	AVMSetTVVideoRegion (AVMTvVideoRegion videoRegion, TVEPort port, AVMTvResolution resolution)
	Sets the TV video region. More...

Detailed Description

Typedef Documentation

AVMTvAspectRatio

typedef enum AVMTvAspectRatio AVMTvAspectRatio

AVMTvResolution

typedef enum AVMTvResolution AVMTvResolution

AVMTvVideoRegion

typedef enum AVMTvVideoRegion AVMTvVideoRegion

Enumeration Type Documentation

AVMTvAspectRatio

enum AVMTvAspectRatio

Enumerator
AVM_TV_ASPECT_RATIO_4_3	4:3
AVM_TV_ASPECT_RATIO_16_9	16:9

Definition at line 15 of file tv.h.

AVMTvResolution

enum AVMTvResolution

Enumerator
AVM_TV_RESOLUTION_576I
AVM_TV_RESOLUTION_480I
AVM_TV_RESOLUTION_480P
AVM_TV_RESOLUTION_720P
AVM_TV_RESOLUTION_720P_3D
AVM_TV_RESOLUTION_1080I
AVM_TV_RESOLUTION_1080P
AVM_TV_RESOLUTION_480I_PAL60
AVM_TV_RESOLUTION_576P
AVM_TV_RESOLUTION_720P_50HZ
AVM_TV_RESOLUTION_1080I_50HZ
AVM_TV_RESOLUTION_1080P_50HZ

Definition at line 23 of file tv.h.

AVMTvVideoRegion

enum AVMTvVideoRegion

Enumerator
AVM_TV_VIDEO_REGION_NTSC
AVM_TV_VIDEO_REGION_PAL

Definition at line 39 of file tv.h.

Function Documentation

AVMDebugIsNTSC()

BOOL AVMDebugIsNTSC

(

void

)

Gets the TV video region.

Returns

TRUE if the region is set to NTSC . FALSE if the region is set to PAL .

AVMGetCurrentPort()

BOOL AVMGetCurrentPort

(

TVEPort *

outPort

)

Gets the TV port.

Parameters

outPort

Pointer to write the port to.

Returns

Always returns TRUE .

See also

• TVEGetCurrentPort()

AVMGetHDMIState()

void AVMGetHDMIState

(

TVEHdmiState *

outState

)

Gets the HDMI state.

Parameters

outState

Pointer to write the state to.

See also

• TVEGetHDMIErrorStat()

AVMGetTVAspectRatio()

BOOL AVMGetTVAspectRatio

(

AVMTvAspectRatio *

outAspectRatio

)

Gets the TV aspect ratio.

Parameters

outAspectRatio

Pointer to write the aspect ratio to.

Returns

Always returns TRUE .

AVMGetTVScanMode()

BOOL AVMGetTVScanMode

(

AVMTvResolution *

outResolution

)

Gets the TV resolution.

Warning

If the resolution is set to AVM_TV_RESOLUTION_480I_PAL60, this function will instead output AVM_TV_RESOLUTION_480I. If the resolution is set to either AVM_TV_RESOLUTION_720P_50HZ, AVM_TV_RESOLUTION_1080I_50HZ, or AVM_TV_RESOLUTION_1080P_50HZ, then nothing will be stored to outResolution .

Parameters

outResolution

Pointer to write the resolution to.

Returns

Always returns TRUE .

AVMGetTVUnderScan()

int32_t AVMGetTVUnderScan

(

uint32_t *

outUnderScan

)

Gets the TV under scan.

Parameters

outUnderScan

Pointer to write the under scan to.

Returns

0 on success or -1 on failure.

AVMIsAVOutReady()

BOOL AVMIsAVOutReady

(

void

)

Determines whether a TV is currently connected and displaying the Wii U source.

Internally checks that either the TVEHdmiState is TVE_HDMI_STATE_DONE or the analog state is 1 , depending on whether the port is set to HDMI or not.

Returns

TRUE if a TV is connected, FALSE otherwise.

See also

• AVMGetHDMIState()
• TVEGetHDMIErrorStat()
• TVEGetAnalogStat()

AVMSetTVAspectRatio()

BOOL AVMSetTVAspectRatio

(

AVMTvAspectRatio

aspectRatio

)

Sets the TV aspect ratio.

Parameters

aspectRatio

Must be one of AVMTvAspectRatio.

Returns

TRUE on success or FALSE on failure.

AVMSetTVEnable()

BOOL AVMSetTVEnable

(

BOOL

enable

)

Sets whether to show or hide the TV video out.

Parameters

enable

If FALSE then a black image is output (i.e. blanks the screen). The TV still receives a signal as normal and still plays audio.

Returns

TRUE on success or FALSE on failure.

AVMSetTVOutPort()

int32_t AVMSetTVOutPort	(	TVEPort	port,
		AVMTvResolution	resolution
	)

Sets the TV port.

Parameters

port	Must be one of TVEPort.
resolution	Must be one of AVMTvResolution.

Returns

0 on success or a negative value on error.

AVMSetTVScanMode()

int32_t AVMSetTVScanMode	(	AVMTvResolution	resolution,
		uint32_t	unknown,
		TVEPort	port
	)

Sets the TV resolution and port.

Parameters

resolution	Must be one of AVMTvResolution.
port	Must be one of TVEPort.

Returns

1 on success.

AVMSetTVScanResolution()

int32_t AVMSetTVScanResolution

(

AVMTvResolution

resolution

)

Sets the TV resolution.

Parameters

resolution

Must be one of AVMTvResolution.

Returns

0 on success or a negative value on error.

AVMSetTVUnderScan()

int32_t AVMSetTVUnderScan

(

uint32_t

underScan

)

Sets the TV under scan.

Parameters

underScan

Must be less than 0x15 .

Returns

0 on success or a negative value on error.

See also

• AVMSetTVUnderScanParam()

AVMSetTVUnderScanParam()

int32_t AVMSetTVUnderScanParam

(

uint32_t

underScan

)

Parameters

underScan

Must be less than 0x15 .

Returns

0 on success or -1 on failure.

See also

• AVMSetTVUnderScan()

AVMSetTVVideoRegion()

int32_t AVMSetTVVideoRegion	(	AVMTvVideoRegion	videoRegion,
		TVEPort	port,
		AVMTvResolution	resolution
	)

Sets the TV video region.

Parameters

videoRegion	Must be one of AVMTvVideoRegion.
port	Must be one of TVEPort.
resolution	Must be one of AVMTvResolution.

Returns

0 on success or a negative value on error.