The IMMRemovableMedia class provides all of the common behavior for all removable media devices. The main purpose of this class is to provide functions for devices that have physical media that is replaceable. Some examples of devices that might inherit from this are videoDiscs, CD players, cassette players, and VCRs. There are functions for loading or ejecting media, determining if media is present, and locking and unlocking a door on the device. Derived classes can use the virtual functions mediaLoaded and mediaUnloaded for determining if the user is changing the media.
Derived classes can use these members to create objects of this class.
![]() |
public:
virtual ~IMMRemovableMedia()
Windows | OS/2 | AIX |
Yes | Yes | No |
![]() |
protected:
IMMRemovableMedia( const IString& deviceName, bool openNow, unsigned long instance, bool openShareable )
A derived class can construct an IMMRemovableMedia from the following:
Windows | OS/2 | AIX |
Yes | Yes | No |
protected:
IMMRemovableMedia( unsigned long deviceIdentifier, const IString& newAlias = IString ( ) )
A derived class can construct an IMMRemovableMedia from the following:
Windows | OS/2 | AIX |
Yes | Yes | No |
Use these members to open, close, lock, and unlock the door on the removable media device.
![]() |
public:
virtual IMMRemovableMedia& closeDoor(CallType call = wait)
Retracts the tray and closes the door, if possible.
IAccessError | The device identifier is not valid; possibly the device is closed. |
IAccessError | The device cannot acquire access to the hardware device; possibly another device of this same type was acquired for exclusive use in this or another process. |
IAccessError | An internal driver error occurred. |
IInvalidRequest | The device must be in the open state before calling this function. |
Windows | OS/2 | AIX |
Yes | Yes | No |
![]() |
public:
bool isMediaPresent(CallType call = wait) const
Returns true if media is inserted in the device; otherwise, it returns false.
IAccessError | The device identifier is not valid; possibly the device is closed. |
IAccessError | The device cannot acquire access to the hardware device; possibly another device of this same type was acquired for exclusive use in this or another process. |
IAccessError | An internal driver error occurred. |
IInvalidRequest | The device must be in the open state before calling this function. |
Windows | OS/2 | AIX |
Yes | Yes | No |
![]() |
public:
virtual IMMRemovableMedia& lockDoor( bool lock = true, CallType call = wait )
Locks the media cover on the device, if any. This disables manual ejection of the media from the device.
IAccessError | The device identifier is not valid; possibly the device is closed. |
IAccessError | The device cannot acquire access to the hardware device; possibly another device of this same type was acquired for exclusive use in this or another process. |
IAccessError | An internal driver error occurred. |
IInvalidRequest | The device must be in the open state before calling this function. |
Windows | OS/2 | AIX |
No | Yes | No |
![]() |
public:
virtual IMMRemovableMedia& openDoor( bool open = true, CallType call = wait )
Opens the door and ejects the tray, if possible.
IAccessError | The device identifier is not valid; possibly the device is closed. |
IAccessError | The device cannot acquire access to the hardware device; possibly another device of this same type was acquired for exclusive use in this or another process. |
IAccessError | An internal driver error occurred. |
IInvalidRequest | The device must be in the open state before calling this function. |
Windows | OS/2 | AIX |
Yes | Yes | No |
![]() |
public:
virtual IMMRemovableMedia& unlockDoor(CallType call = wait)
Unlocks the media cover on the device, if any. This enables manual ejection of the media from the device.
IAccessError | The device identifier is not valid; possibly the device is closed. |
IAccessError | The device cannot acquire access to the hardware device; possibly another device of this same type was acquired for exclusive use in this or another process. |
IAccessError | An internal driver error occurred. |
IInvalidRequest | The device must be in the open state before calling this function. |
Windows | OS/2 | AIX |
No | Yes | No |
Event-dispatching members interact with the notification handlers for this device.
![]() |
public:
virtual IMMRemovableMedia& enableNotification( bool enabled = true )
Flags this object as being ready to accept notifications. A Notifier, like IMMRemovableMedia, does not send notifications to observer objects until it is enabled.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
protected:
IMMRemovableMediaNotifyHandler* notificationHandler() const
Returns a pointer to the notification handler.
Windows | OS/2 | AIX |
Yes | Yes | No |
![]() |
protected:
IMMRemovableMedia& setNotificationHandler( IMMRemovableMediaNotifyHandler* notifyHandler )
Sets the notification handler to the passed value.
Windows | OS/2 | AIX |
Yes | Yes | No |
This INotificationId string is used for notifications that IMMRemovableMedia provides to its observers.
![]() |
public:
static INotificationId const mediaLoadedId
Notification identifier provided to observers when the current media-loaded state changes. IMMRemovableMedia provides a boolean value in the eventData field of the INotificationEvent. This value is true if the media is loaded and false, if the media is unloaded.
Windows | OS/2 | AIX |
Yes | Yes | No |
virtual ~IMMDevice()
virtual IMMDevice& acquire( ShareMode acquire = shareable, bool queuedForResources = false, CallType call = wait )
IString aliasName() const
virtual IMMDevice& close(CallType call = wait)
unsigned long connectedDeviceId( ConnectorType type, CallType call = wait ) const
virtual IMMDevice& deletePendingEvents( EventType event = allEvents )
IString description(CallType call = wait) const
unsigned long deviceId() const
IString deviceName() const
unsigned long deviceType(CallType call = wait) const
virtual IMMDevice& disableAudio( AudioChannel channel = all, const IMMMillisecondTime& over = IMMMillisecondTime ( ), CallType call = wait )
virtual IMMDevice& disableConnector( ConnectorType type, CallType call = wait )
virtual IMMDevice& enableAudio( bool enable = true, AudioChannel channel = all, const IMMMillisecondTime& over = IMMMillisecondTime ( ), CallType call = wait )
virtual IMMDevice& enableConnector( ConnectorType type, bool enable = true, CallType call = wait )
virtual IMMDevice& enableNotification(bool enabled = true)
bool isAcquired(CallType call = wait) const
bool isAudioEnabled( AudioChannel channel = all, CallType call = wait )
bool isCloseOnDestroy() const
bool isConnectionSupported( ConnectorType type, CallType call = wait ) const
bool isConnectorEnabled( ConnectorType type, CallType call = wait ) const
bool isOpen() const
virtual Mode mode(CallType call = wait) const
virtual IMMDevice& open( const IString& fileOrDevice = IString ( ), bool shareable = true, CallType call = wait )
virtual IMMDevice& openOnThread( const IString& fileOrDevice = IString ( ), bool shareable = true, CallType call = wait )
IMMTime prerollTime(CallType call = wait) const
PrerollType prerollType(CallType call = wait) const
virtual IMMDevice& release(CallType call = wait)
bool requiresFiles(CallType call = wait) const
IMMDevice& setCloseOnDestroy(bool close = true)
virtual IMMDevice& setSpeedFormat( IMMSpeed::Format format, CallType call = wait )
virtual IMMDevice& setTimeFormat( IMMTime::Format format, CallType call = wait )
virtual IMMDevice& setVolume( unsigned long volume, AudioChannel channel = all, const IMMMillisecondTime& over = IMMMillisecondTime ( ), CallType call = wait )
IMMSpeed::Format speedFormat(CallType call = wait) const
bool supportsAudio(CallType call = wait) const
bool supportsCommand( IMMNotifyEvent::Command command, CallType call = wait ) const
bool supportsDigitalTransfer(CallType call = wait) const
bool supportsDisableEject(CallType call = wait) const
bool supportsEject(CallType call = wait) const
bool supportsPlay(CallType call = wait) const
bool supportsRecord(CallType call = wait) const
bool supportsRecordInsertion(CallType call = wait) const
bool supportsSave(CallType call = wait) const
bool supportsStreaming(CallType call = wait) const
bool supportsVideo(CallType call = wait) const
bool supportsVolumeAdjustment(CallType call = wait) const
IMMTime::Format timeFormat(CallType call = wait) const
virtual unsigned long volume( AudioChannel channel = left, CallType call = wait ) const
virtual ~IMMPlayableDevice()
virtual IMMPlayableDevice& addCuePoint( const IMMTime& time, CallType call = wait )
virtual IMMPlayableDevice& cueForPlayback( CallType call = wait )
unsigned long length(CallType call = wait) const
virtual IMMPlayableDevice& pause(CallType call = wait)
virtual IMMPlayableDevice& play( const IMMTime& from = IMMTime ( ), const IMMTime& to = IMMTime ( ), bool resumeIfPaused = true, CallType call = nowait )
unsigned long position(CallType call = wait) const
virtual IMMPlayableDevice& removeCuePoint( const IMMTime& time, CallType call = wait )
virtual IMMPlayableDevice& resume( bool resume = true, CallType call = wait )
virtual IMMPlayableDevice& seek( const IMMTime& to, CallType call = wait )
virtual IMMPlayableDevice& seekToEnd(CallType call = wait)
virtual IMMPlayableDevice& seekToStart( CallType call = wait )
virtual IMMPlayableDevice& startPositionTracking( const IMMTime& timeInterval, CallType call = wait )
virtual IMMPlayableDevice& stepFrame( unsigned long frames = 1, bool forward = true, CallType call = wait )
virtual IMMPlayableDevice& stop(CallType call = wait)
virtual IMMPlayableDevice& stopPositionTracking( CallType call = wait )
virtual ~INotifier()
virtual INotifier& disableNotification() = 0
virtual INotifier& enableNotification( bool enable = true ) = 0
INotifier()
virtual bool isEnabledForNotification() const = 0
virtual INotifier& notifyObservers( const INotificationEvent& event ) = 0
virtual INotifier& notifyObserversAsync( const INotificationEvent& event )
const IThreadId& threadId() const
virtual ~IStandardNotifier()
virtual IStandardNotifier& disableNotification()
virtual IStandardNotifier& enableNotification( bool enable = true )
virtual bool isEnabledForNotification() const
IStandardNotifier(const IStandardNotifier& copy)
IStandardNotifier()
virtual INotifierAddress notifierAddress() const
virtual IStandardNotifier& notifyObservers( const INotificationEvent& anEvent )
virtual IStandardNotifier& notifyObserversAsync( const INotificationEvent& anEvent )
IStandardNotifier& operator =( const IStandardNotifier& aStandardNotifier )
static INotificationId const allChangesId
static INotificationId const deleteId
static const unsigned long allDevices
static const unsigned long ampMixer
static const unsigned long animation
static const unsigned long audioCD
static const unsigned long audioTape
static const unsigned long cdxa
static INotificationId const commandNotifyId
static INotificationId const cuePointId
static const unsigned long dat
static INotificationId const deviceEventId
static const unsigned long digitalVideo
static const unsigned long headphone
static const unsigned long microphone
static const unsigned long monitor
static const unsigned long other
static const unsigned long overlay
static INotificationId const passDeviceId
static INotificationId const positionChangeId
static const unsigned long sequencer
static const unsigned long speaker
static const unsigned long videoDisc
static const unsigned long videoTape
static const unsigned long waveAudio
virtual INotifier& addObserver( IObserver& observer, const IInterest& interest )
virtual INotifier& notifyObservers( const INotificationId& id ) = 0
virtual IObserverList& observerList( const IInterest* anInterest = 0 ) const = 0
virtual INotifier& removeAllObservers() = 0
virtual INotifier& removeObserver( IObserver& observer, const IInterest& interest )
virtual INotifier& removeObserver(IObserver& observer) = 0
virtual IStandardNotifier& addObserver( IObserver& observer, const IInterest& interest )
virtual IStandardNotifier& notifyObservers( const INotificationId& nId )
virtual IObserverList& observerList( const IInterest* anInterest = 0 ) const
virtual IStandardNotifier& removeAllObservers()
virtual IStandardNotifier& removeObserver( IObserver& observer )
virtual IStandardNotifier& removeObserver( IObserver& observer, const IInterest& interest )
IMMMessageWindow& deviceWindow() const
IMMDevice(const IString& fileOrDevice)
IMMDevice( unsigned long deviceIdentifier, const IString& newAlias = IString ( ) )
virtual bool isOpenStringValid( const IString& deviceName ) const
unsigned long itemCapability( unsigned long item, CallType call ) const
unsigned long itemStatus( unsigned long item, unsigned long value = 0, CallType call = wait ) const
unsigned long lastError() const
virtual bool mixerControlValues( unsigned long dwComponentType, unsigned long dwControlType, unsigned short* usDetails, bool uniform = true, unsigned long multipleItems = 0, unsigned long hmx = NULL )
virtual bool mixerControlValues( unsigned long dwComponentType, unsigned long dwControlType, unsigned long* ulDetails, bool uniform = true, unsigned long multipleItems = 0, unsigned long hmx = NULL )
IMMDeviceNotifyHandler* notificationHandler() const
virtual IMMDevice& open( unsigned long instanceNumber, bool shareable = true, CallType call = nowait )
virtual IMMDevice& openOnThread( unsigned long instanceNumber, bool shareable = true )
OpenStatus openStatus() const
virtual IMMDevice& restoreDeviceSettings( bool newRecordMode = false )
virtual IMMDevice& saveDeviceSettings()
IString sendCommand( const IString& command, unsigned short userParm )
IString sendCommand(const IString& command)
IMMDevice& sendCommand( unsigned short message, unsigned long param1, void* param2, unsigned short userParm )
IMMDevice& sendCommand( unsigned short message, unsigned long param1, void* param2 )
IMMDevice& setLastError(unsigned long errorId)
virtual bool setMixerControlValues( unsigned long dwComponentType, unsigned long dwControlType, unsigned long* ulDetails, bool uniform = true, unsigned long multipleItems = 0, unsigned long hmx = NULL )
virtual bool setMixerControlValues( unsigned long dwComponentType, unsigned long dwControlType, unsigned short* usDetails, bool uniform = true, unsigned long multipleItems = 0, unsigned long hmx = NULL )
IMMDevice& setNotificationHandler( IMMDeviceNotifyHandler* notifyHandler )
IMMDevice& setOpenStatus(OpenStatus status)
IMMDevice& setPassDeviceRequested(bool sawPassDevice)
IMMDevice& setSystemMixerHandle(unsigned long hmx)
IMMDevice& setUserParameter(unsigned short userParm = 0)
unsigned long systemMixerHandle() const
unsigned short userParameter() const
bool wasPassDeviceRequested() const
IMMPlayableDevice( unsigned long deviceIdentifier, const IString& newAlias = IString ( ) )
IMMPlayableDevice( const IString& deviceOrFileName, bool openNow = true, unsigned long instance = 0, bool openShareable = true )
virtual IMMPlayableDevice& restoreDeviceSettings( bool newRecordMode = false )
virtual IMMPlayableDevice& saveDeviceSettings()