DVDGetDriveStatus

Syntax

#include <revolution/dvd.h>

s32 DVDGetDriveStatus(void);

Arguments

None.

Return Values

DVD_STATE_FATAL_ERROR Fatal error occurred.
DVD_STATE_END Request complete or no request.
DVD_STATE_BUSY Request is currently processing.
DVD_STATE_NO_DISK No disk in the drive.
DVD_STATE_WRONG_DISK Wrong disk in the drive.
DVD_STATE_MOTOR_STOPPED Motor stopped.
DVD_STATE_PAUSING The device driver is paused using the DVD Pause function.
DVD_STATE_RETRY Retry error occurred.

Note: Controller input wait state will not be supported in the near term.

Note: The error message DVD_STATE_COVER_OPEN used in GameCube was deleted.

Note:  When using the release version of the DVD library, if the DVDFileInfo structure is used mistakenly in a program, DVD_STATE_WAITING may be returned. This situation can occur if the DVDFileInfo structure is reused in a new DVD command similar to the current DVD transfer. In the debug version of the library, this case causes an assert error.

Description

Gets the current status of the optical disc drive. In the case that a DVD request is currently executing, this function is the same as specifying the command block of this request using the DVDGetCommandBlockStatus function. Depending on the pause state of the device driver and if no outstanding requests exist, the DVDGetDriveStatus function returns DVD_STATE_END or DVD_STATE_PAUSING. For more information about the pause state, see the DVDPause function.

If this function is called in a callback, it returns DVD_STATE_END even if requests exist in the queue. This return code is returned because the previous request has completed processing, but the next request in the queue has not yet started processing.

If no DVD command is processing, this function returns DVD_STATE_END or DVD_STATE_PAUSING. This has the following meaning.

These statuses (no disc, wrong disc, and so on) are returned only if a DVD command is processing, but cannot complete because of these statuses.

See Also

DVDGetCommandBlockStatus

Revision History

2006/09/19 Removed description of DVD_STATE_NO_INPUT.
2006/09/07 Added description of DVD_STATE_NO_INPUT.
2006/03/01 Initial version.


CONFIDENTIAL