AudioFile.Open Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| Open(String, AudioFilePermission, AudioFileError, AudioFileType) |
Opens an audio file for reading. |
| Open(CFUrl, AudioFilePermission, AudioFileError, AudioFileType) |
Opens an audio file for reading. |
| Open(NSUrl, AudioFilePermission, AudioFileError, AudioFileType) |
Opens an audio file for reading. |
| Open(NSUrl, AudioFilePermission, AudioFileType) |
Opens an audio file for reading. |
| Open(String, AudioFilePermission, AudioFileType) |
Opens an audio file for reading. |
| Open(CFUrl, AudioFilePermission, AudioFileType) |
Opens an audio file for reading. |
Open(String, AudioFilePermission, AudioFileError, AudioFileType)
Opens an audio file for reading.
public static AudioToolbox.AudioFile? Open(string url, AudioToolbox.AudioFilePermission permissions, out AudioToolbox.AudioFileError error, AudioToolbox.AudioFileType fileTypeHint =(AudioToolbox.AudioFileType) 0);static member Open : string * AudioToolbox.AudioFilePermission * AudioFileError * AudioToolbox.AudioFileType -> AudioToolbox.AudioFileParameters
- url
- String
A url to a local file name.
- permissions
- AudioFilePermission
The permissions to use when opening the file.
- error
- AudioFileError
Success if successful, or an error code otherwise.
- fileTypeHint
- AudioFileType
A hint indicating the file format expected, this is necessary for audio files where the operating system can not probe the type by looking at the file signature or file extension (for example AC3). Pass zero to auto detect the format.
Returns
An instance of AudioFile on success, or null on error.
Remarks
The hint is necessary as sometimes it is not possible to determine the file type merely based on the contents of the file.
Once you have opened the file for reading, you can use the various Read methods to decode the audio packets contained in the file.
Applies to
Open(CFUrl, AudioFilePermission, AudioFileError, AudioFileType)
Opens an audio file for reading.
public static AudioToolbox.AudioFile? Open(CoreFoundation.CFUrl url, AudioToolbox.AudioFilePermission permissions, out AudioToolbox.AudioFileError error, AudioToolbox.AudioFileType fileTypeHint =(AudioToolbox.AudioFileType) 0);static member Open : CoreFoundation.CFUrl * AudioToolbox.AudioFilePermission * AudioFileError * AudioToolbox.AudioFileType -> AudioToolbox.AudioFileParameters
- url
- CFUrl
A url to a local file name.
- permissions
- AudioFilePermission
The permissions to use when opening the file.
- error
- AudioFileError
Success if successful, or an error code otherwise.
- fileTypeHint
- AudioFileType
A hint indicating the file format expected, this is necessary for audio files where the operating system can not probe the type by looking at the file signature or file extension (for example AC3). Pass zero to auto detect the format.
Returns
An instance of AudioFile on success, or null on error.
Applies to
Open(NSUrl, AudioFilePermission, AudioFileError, AudioFileType)
Opens an audio file for reading.
public static AudioToolbox.AudioFile? Open(Foundation.NSUrl url, AudioToolbox.AudioFilePermission permissions, out AudioToolbox.AudioFileError error, AudioToolbox.AudioFileType fileTypeHint =(AudioToolbox.AudioFileType) 0);static member Open : Foundation.NSUrl * AudioToolbox.AudioFilePermission * AudioFileError * AudioToolbox.AudioFileType -> AudioToolbox.AudioFileParameters
- url
- NSUrl
A url to a local file name.
- permissions
- AudioFilePermission
The permissions to use when opening the file.
- error
- AudioFileError
Success if successful, or an error code otherwise.
- fileTypeHint
- AudioFileType
A hint indicating the file format expected, this is necessary for audio files where the operating system can not probe the type by looking at the file signature or file extension (for example AC3). Pass zero to auto detect the format.
Returns
An instance of AudioFile on success, or null on error.
Applies to
Open(NSUrl, AudioFilePermission, AudioFileType)
Opens an audio file for reading.
public static AudioToolbox.AudioFile? Open(Foundation.NSUrl url, AudioToolbox.AudioFilePermission permissions, AudioToolbox.AudioFileType fileTypeHint =(AudioToolbox.AudioFileType) 0);static member Open : Foundation.NSUrl * AudioToolbox.AudioFilePermission * AudioToolbox.AudioFileType -> AudioToolbox.AudioFileParameters
- url
- NSUrl
A url to a local file name.
- permissions
- AudioFilePermission
The permissions to use when opening the file.
- fileTypeHint
- AudioFileType
A hint indicating the file format expected, this is necessary for audio files where the operating system can not probe the type by looking at the file signature or file extension (for example AC3). Pass zero to auto detect the format.
Returns
An instance of AudioFile on success, or null on error.
Applies to
Open(String, AudioFilePermission, AudioFileType)
Opens an audio file for reading.
public static AudioToolbox.AudioFile? Open(string url, AudioToolbox.AudioFilePermission permissions, AudioToolbox.AudioFileType fileTypeHint =(AudioToolbox.AudioFileType) 0);static member Open : string * AudioToolbox.AudioFilePermission * AudioToolbox.AudioFileType -> AudioToolbox.AudioFileParameters
- url
- String
A url to a local file name.
- permissions
- AudioFilePermission
The permissions to use when opening the file.
- fileTypeHint
- AudioFileType
A hint indicating the file format expected, this is necessary for audio files where the operating system can not probe the type by looking at the file signature or file extension (for example AC3). Pass zero to auto detect the format.
Returns
An instance of AudioFile on success, or null on error.
Remarks
The hint is necessary as sometimes it is not possible to determine the file type merely based on the contents of the file.
Once you have opened the file for reading, you can use the various Read methods to decode the audio packets contained in the file.
Applies to
Open(CFUrl, AudioFilePermission, AudioFileType)
Opens an audio file for reading.
public static AudioToolbox.AudioFile? Open(CoreFoundation.CFUrl url, AudioToolbox.AudioFilePermission permissions, AudioToolbox.AudioFileType fileTypeHint =(AudioToolbox.AudioFileType) 0);static member Open : CoreFoundation.CFUrl * AudioToolbox.AudioFilePermission * AudioToolbox.AudioFileType -> AudioToolbox.AudioFileParameters
- url
- CFUrl
A url to a local file name.
- permissions
- AudioFilePermission
The permissions to use when opening the file.
- fileTypeHint
- AudioFileType
A hint indicating the file format expected, this is necessary for audio files where the operating system can not probe the type by looking at the file signature or file extension (for example AC3). Pass zero to auto detect the format.
Returns
An instance of AudioFile on success, or null on error.