 Oracle Sound Control Help Index

Properties

Methods

Events

Property Pages


No Help Available

No help is available for this area of the window.


No Help Available

No help is available for this message box.

<< If you wish to author help specific to each message box prompt, then remove the AFX_HIDP_xxx values from the [ALIAS] section of your .HPJ file, and author a topic for each AFX_HIDP_xxx value.  For example, AFX_HIDP_INVALID_FILENAME is the help topic for the Invalid Filename message box. >>


Oracle Sound Control Property Pages

General Property Page

Import/Export Property Page

Edit Property Page

Device Property Page

Sound Information Property Page


General Property Page

ShowLevel	BOOL

Determines whether or not the level indicator will appear in the Sound OCX view box.

ShowSoundInfo	BOOL

Determines whether or not information on the current sound (rate, datatype, length) will appear in the Sound OCX view box.

ShowTimeIndex	BOOL

Determines whether or not the time index will appear in the Sound OCX view box.

ShowVolume	BOOL

Determines whether or not the volume control will appear in the Sound OCX view box.

ShowInputDevice	BOOL

Determines whether or not the input device selection area will appear in the Sound OCX view box.

BorderStyle	SHORT

Returns or sets the border style for an OCX custom control. This is a stock property.

ViewMode	SHORT

Determines how the Sound OCX will appear, either as a dialog (0) or an icon (1). Note that if the Sound OCX appears as an icon, the only operation possible will be the playing of the entire sound when clicked upon.


Sound Information Property Page

SoundFormat	BSTR  (Read-Only)

This read-only property identifies the sound format of the most recently imported sound.

SoundDatatype	SHORT  (Read-Only)

This read-only property indicates both the sample width and number of channels (mono/stereo) for the most recently imported sound.

SoundCompressionScheme	BSTR  (Read-Only)

This read-only property identifies the compression scheme of the most recently imported sound.

SoundRate	SHORT  (Read-Only)

This read-only property indicates the sampling rate of the most recently imported sound.

Length	LONG

This property indicates the total length of the current sound in msec.


Import/Export Property Page

ImportFileSpec	BSTR

When this property is set to a fully qualified filename, the referenced sound will be immediately imported. The format, datatype, sampling rate, and compression scheme of the sound will be automatically identified by the Sound OCX

ExportFormat	BSTR

Identifies the sound format to be used for a subsequent sound export operation. The default value of this property is "WAVF".

ExportDatatype	SHORT

Identifies the datatype for a subsequent export operation, which includes both the width of a sample in bits, and the number of channels (mono/stereo). Note that this property is merely a request to the Sound OCX; for example, if the current ExportFormat only supports 8-bit mono sounds, the value of this property is ignored. The default value of this property is "Automatic".

ExportRate	SHORT

Identifies the sampling rate for a subsequent sound export operation. Note that this property is merely a request to the Sound OCX; for example, if the current ExportFormat only supports 8kHz sounds, the value of this property is ignored.

ExportCompression	BOOL

Indicates whether or not the current sound should be compressed during export. Note that the value of this property is merely a request to the Sound OCX; for example, if the current ExportFormat supports only compressed (or uncompressed) data, the value of this property is ignored. The default value of this property is FALSE.

ExportCompressionQuality	SHORT

When compression is available for the current ExportFormat, this property indicates the level of compression desired. The values for this property range from "Maximize Integrity" to "Maximize Compression". Note that this property is merely a request to the Sound OCX; for example, if the current ExportFormat supports only lossless compression, the value of this property is ignored. The default value of this property is "Maximize Integrity".


Edit Property Page

AllowRecord	BOOL

Determines whether or not the record button on the sound control will be enabled. Note that if the ViewMode property is set to "icon", the value of this property is irrelevant.

MaxRecordLength	LONG

This property indicates the maximum length in msec that a sound can reach during recording. Note that if a sound which exceeds MaxRecordLength is imported, the Sound OCX will behave appropriately and not enforce MaxRecordLength (in this case, the maximum recording length will be the length of the imported sound).


Device Property Page

InputDevice	SHORT

Determines the input device to be used during recording.

PlayVolume	SHORT

Indicates the volume at which the current sound should be played. Must be between 0 and 255.


Oracle Sound Control Properties

AllowRecord	BOOL

Determines whether or not the record button on the sound control will be enabled. Note that if the ViewMode property is set to "icon", the value of this property is irrelevant.

BorderStyle	SHORT

Returns or sets the border style for an OCX custom control. This is a stock property.

ExportCompression	BOOL

Indicates whether or not the current sound should be compressed during export. Note that the value of this property is merely a request to the Sound OCX; for example, if the current ExportFormat supports only compressed (or uncompressed) data, the value of this property is ignored. The default value of this property is FALSE.

ExportCompressionQuality	SHORT

When compression is available for the current ExportFormat, this property indicates the level of compression desired. The values for this property range from "Maximize Integrity" to "Maximize Compression". Note that this property is merely a request to the Sound OCX; for example, if the current ExportFormat supports only lossless compression, the value of this property is ignored. The default value of this property is "Maximize Integrity".

ExportDatatype	SHORT

Identifies the datatype for a subsequent export operation, which includes both the width of a sample in bits, and the number of channels (mono/stereo). Note that this property is merely a request to the Sound OCX; for example, if the current ExportFormat only supports 8-bit mono sounds, the value of this property is ignored. The default value of this property is "Automatic".

ExportFileSpec	BSTR

When this property is set to a fully qualified filename, the current sound will be immediately exported. Note that the current values of ExportFormat, ExportRate, ExportDatatype, ExportCompression, and ExportCompressionQuality will be used during the export process.

ExportFormat	BSTR

Identifies the sound format to be used for a subsequent sound export operation. The default value of this property is "WAVF".

ExportRate	SHORT

Identifies the sampling rate for a subsequent sound export operation. Note that this property is merely a request to the Sound OCX; for example, if the current ExportFormat only supports 8kHz sounds, the value of this property is ignored.

HasSound	BOOL

Indicates whether or not there is a valid sound associated with the Sound OCX. When the OCX is first created, there is no sound associated with it. To associate a sound with a Sound OCX, one of the import methods or CreateNew() must be called.

ImportFileSpec	BSTR

When this property is set to a fully qualified filename, the referenced sound will be immediately imported. The format, datatype, sampling rate, and compression scheme of the sound will be automatically identified by the Sound OCX

InputDevice	SHORT

Determines the input device to be used during recording.

IsModified	BOOL

Indicates whether the current sound has been modified in any way since the most recent import operation.

Length	LONG

This property indicates the total length of the current sound in msec.

MaxRecordLength	LONG

This property indicates the maximum length in msec that a sound can reach during recording. Note that if a sound which exceeds MaxRecordLength is imported, the Sound OCX will behave appropriately and not enforce MaxRecordLength (in this case, the maximum recording length will be the length of the imported sound).

PlayVolume	SHORT

Indicates the volume at which the current sound should be played. Must be between 0 and 255.

Position	LONG

Indicates in msec where in the current sound the next play or record operation will proceed from.

Preferences	BOOL

Determines whether filter options are available to the user during import and export.

ShowInputDevice	BOOL

Determines whether or not the input device selection area will appear in the Sound OCX view box.

ShowLevel	BOOL

Determines whether or not the level indicator will appear in the Sound OCX view box.

ShowSoundInfo	BOOL

Determines whether or not information on the current sound (rate, datatype, length) will appear in the Sound OCX view box.

ShowTimeIndex	BOOL

Determines whether or not the time index will appear in the Sound OCX view box.

ShowVolume	BOOL

Determines whether or not the volume control will appear in the Sound OCX view box.

SoundCompressionScheme	BSTR  (Read-Only)

This read-only property identifies the compression scheme of the most recently imported sound.

SoundDatatype	SHORT  (Read-Only)

This read-only property indicates both the sample width and number of channels (mono/stereo) for the most recently imported sound.

SoundRate	SHORT  (Read-Only)

This read-only property indicates the sampling rate of the most recently imported sound.

SoundFormat	BSTR  (Read-Only)

This read-only property identifies the sound format of the most recently imported sound.

ViewMode	SHORT

Determines how the Sound OCX will appear, either as a dialog (0) or an icon (1). Note that if the Sound OCX appears as an icon, the only operation possible will be the playing of the entire sound when clicked upon.

Visible	BOOL

Determines whether the Sound OCX view box is visible or hidden.


Oracle Sound Control Methods

Copy()

Copies the current sound to the clipboard.

CreateNew(SHORT Rate, SHORT Datatype)

When this method is called, a new sound will be created and will become the current sound.

ExportFileAs()

When this method is called, a dialog will be provided which will allow the user to specify the export file specification, format, sampling rate, datatype, compression scheme, and compression quality. When the user presses the "OK" button on the dialog, the sound is exported.

ExportMemory(SAFEARRAY as VARIANT)

When this method is called, the current sound will be exported to the in-memory data stream referenced by the VARIANT parameter which must be a pointer to a SAFEARRAY. The export will take place using the format, rate, datatype, and compression scheme specified by the ExportFormat, ExportRate, ExportDatatype, ExportCompression, and ExportCompressionQuality properties, respectively.

ExportStream(VARIANT by reference)

When this method is called, the current sound will be exported to the stream defined by the VARIANT parameter. The VARIANT parameter must be of type VT_IUNKNOWN, and the punkVal must be set to point to an ILockBytes interface. The export will take place using the format, rate, datatype, and compression scheme specified by the ExportFormat, ExportRate, ExportDatatype, ExportCompression, and ExportCompressionQuality properties, respectively.

ExportStreamAs(VARIANT by reference)

When this method is called, a dialog will be provided which will allow the user to specify the export format, sampling rate, compression scheme, and compression quality. When the user presses the "OK" button on the dialog, the sound is exported to the stream defined by the VARIANT parameter. The VARIANT parameter must be of type VT_IUNKNOWN, and the punkVal must be set to point to an ILockBytes interface.

ImportFileAs()

When this method is called, a dialog will be provided which will allow the user to specify the import file specification and format. When the user presses the "OK" button on the dialog, the sound is imported.

ImportMemory(SAFEARRAY as VARIANT)

When this method is called, a sound will be imported from the in-memory data stream referenced by the VARIANT parameter which must be a pointer to a SAFEARRAY. Once the sound is imported, the SAFEARRAY is no longer needed and can be deallocated.

ImportStream(VARIANT by reference)

When this method is called, a sound will be imported from the stream defined by the VARIANT parameter. The VARIANT parameter must be of type VT_IUNKNOWN, and the punkVal must be set to point to an ILockBytes interface.

Play()

When this method is called, the current sound will start playing from the position specified by the Position property.

Record()

When this method is called, the Sound OCX will start recording into the current sound starting at the position specified by the Position property.

Stop()

When this method is called, the current Play() or Record() operation will be terminated.


Oracle Sound Control Events

Completed

This event is delivered when a Play() or Record() operation completes by itself. In other words, the sound being played has reached its end, or the length of the sound has reached MaxRecordLength while recording.

PlayStarted

This event is delivered when a play operation is started, either through calling the Play() method, or by pushing the play button.

RecordStarted

This event is delivered when a record operation is started, either through calling the Record() method, or by pushing the record button.

RightClick

This event is delivered when the user clicks the right mouse button while the Sound OCX is active.

Stopped

This event is delivered when a play or record operation is stopped, either through calling the Stop() method, or by pushing the stop button. Note that the Stopped event is not delivered when a play or record operation completes by itself; in this case, only the Completed event will be delivered.