The IMMFileMedia is the base class for devices that use files, and it provides functions for loading data from a file.
Derived classes can use these members to create objects of this class.
![]() |
protected:
IMMFileMedia( const IString& deviceName, bool openNow, unsigned long instance, bool openShareable )
A derived class can construct an IMMFileMedia from the following:
Windows | OS/2 | AIX |
Yes | Yes | No |
protected:
IMMFileMedia( unsigned long deviceIdentifier, const IString& newAlias = IString ( ) )
A derived class can construct an IMMFileMedia from the following:
Windows | OS/2 | AIX |
Yes | Yes | No |
Use these members to load a file into the device and to query information about the currently loaded file, for example, the file name and if the file was loaded as read-only.
![]() |
public:
IString filename(CallType call = wait) const
Returns the currently loaded file name.
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. |
IAccessError | The file was not found; possibly there is no loaded file. |
Windows | OS/2 | AIX |
Yes | Yes | No |
![]() |
public:
virtual bool isWriteable() const
Returns false if the file was loaded as read-only; otherwise, true is returned. If the file was loaded as read-only, then the system prevents any changes to the file. The audio driver might also be able to improve load and runtime performance as no changes are allowed. Save and record functions throw an exception if the file was loaded as read-only.
Windows | OS/2 | AIX |
Yes | Yes | No |
![]() |
public:
virtual IMMFileMedia& load( const IString& filename, bool readOnly = false, CallType call = wait )
Loads the given file into memory. If the file does not exist, a temporary file is created. Note, if call is wait , then the windowing system is tied up until the file is loaded. If you do not want to tie up of the windowing system and you do not want the load function to return until the file is loaded, use the loadOnThread function. Otherwise, you could set call to nowait, which causes this function to return immediately. When the load finishes, an INotificationEvent is sent to any observers that are attached to this device, notifying them that the load has finished.
If the file is loaded as read-only, the system prevents any changes being made to the file. The audio driver might also be able to improve load and runtime performance as no changes are allowed. Save and record functions throw an exception if the file was loaded as read-only.
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. |
IAccessError | The file is not found. |
IAccessError | Invalid media type or invalid data format. |
IAccessError | A hardware error occurred. |
IAccessError | A file attribute error occurred. |
IAccessError | This format is unsupported; possibly the hardware does not support the samples-per-second, the bits-per-sample, the number of channels, or the audio format. |
Windows | OS/2 | AIX |
Yes | Yes | No |
![]() |
public:
virtual IMMFileMedia& loadOnThread( const IString& filename, bool readOnly = false )
Loads the given file into memory by creating a thread to do the actual loading. By doing the loading this way, it does not tie up the windowing system. This function does not return until the file is loaded. If the file does not exist, a temporary file is created.
If the file is loaded as read-only, the system prevents any changes being made to the file. The audio driver might also be able to improve load and runtime performance as no changes are allowed. Save and record functions throw an exception if the file was loaded as read-only.
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. |
IAccessError | The file is not found. |
IAccessError | Invalid media type or invalid data format. |
IAccessError | A hardware error occurred. |
IAccessError | A file attribute error occurred. |
IAccessError | This format is unsupported; possibly the hardware does not support the samples-per-second, the bits-per-sample, the number of channels, or the audio format. |
Windows | OS/2 | AIX |
Yes | Yes | No |
The Win32 MCI does not support threads, so this function behaves like load() in this environment.
![]() |
Opens the device.
public:
virtual IMMFileMedia& open( const IString& fileOrDevice = IString ( ), bool shareable = true, CallType call = wait )
Windows | OS/2 | AIX |
Yes | Yes | No |
This member is overridden in this derived class for specific operating system behavior.
protected:
virtual IMMFileMedia& open( unsigned long instanceNumber, bool shareable = true, CallType call = nowait )
Windows | OS/2 | AIX |
Yes | Yes | No |
This member is overridden in this derived class for specific operating system behavior.
![]() |
Opens the device.
public:
virtual IMMFileMedia& openOnThread( const IString& fileOrDevice = IString ( ), bool shareable = true, CallType call = wait )
Windows | OS/2 | AIX |
Yes | Yes | No |
This member is overridden in this derived class for specific operating system behavior.
protected:
virtual IMMFileMedia& openOnThread( unsigned long instanceNumber, bool shareable = true )
Windows | OS/2 | AIX |
Yes | Yes | No |
This member is overridden in this derived class for specific operating system behavior.
These members change the read-only state of the flag for the loaded file.
![]() |
protected:
virtual IMMFileMedia& enableDataUpdate(bool update = true)
Allows the device to track read-only status of the loaded file.
Windows | OS/2 | AIX |
Yes | Yes | No |
![]() |
protected:
virtual IMMFileMedia& restoreDeviceSettings( bool newRecordMode = false )
Restores settings for the current device. Derived classes should override this function, handle class-specific settings, and call the corresponding inherited function.
Windows | OS/2 | AIX |
Yes | No | No |
![]() |
protected:
virtual IMMFileMedia& saveDeviceSettings()
Saves settings for the current device. Derived classes should override this function, handle class-specific settings, and call the corresponding inherited function.
Windows | OS/2 | AIX |
Yes | No | 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()
IStandardNotifier(const IStandardNotifier& copy)
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 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 )
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
IMMMessageWindow& deviceWindow() const
IMMDevice( unsigned long deviceIdentifier, const IString& newAlias = IString ( ) )
IMMDevice(const IString& fileOrDevice)
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)
IMMDevice& sendCommand( unsigned short message, unsigned long param1, void* param2, unsigned short userParm )
IMMDevice& sendCommand( unsigned short message, unsigned long param1, void* param2 )
IString sendCommand( const IString& command, unsigned short userParm )
IMMDevice& setLastError(unsigned long errorId)
virtual bool setMixerControlValues( unsigned long dwComponentType, unsigned long dwControlType, unsigned short* usDetails, bool uniform = true, unsigned long multipleItems = 0, unsigned long hmx = NULL )
virtual bool setMixerControlValues( unsigned long dwComponentType, unsigned long dwControlType, unsigned long* ulDetails, 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()