Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixing ApiAnalyzer errors. #1794

Merged
merged 1 commit into from
Jan 24, 2017
Merged

Fixing ApiAnalyzer errors. #1794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions Frameworks/AudioToolbox/AudioConverter.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ - (float)getSizeChangeMultiplier {
@end

/**
@Status Caveat: AudioConverter supported only for conversions through AudioConverterConvertBuffer.
Returns kAudioConverterErr_UnspecifiedError on failure and noErr (0) on success. Other return types not supported.
@Notes
@Status Caveat
@Notes AudioConverter supported only for conversions through AudioConverterConvertBuffer.
Returns kAudioConverterErr_UnspecifiedError on failure and noErr (0) on success. Other return types not supported.
*/
OSStatus AudioConverterDispose(AudioConverterRef inAudioConverter) {
RETURN_AUDIOERR_IF_FAILED_WITH_MSG(MFShutdown(), @"MFShutdown Failed");
Expand Down Expand Up @@ -98,9 +98,10 @@ OSStatus _setMFProperties(const AudioStreamBasicDescription* format, IMFMediaTyp
}

/**
@Status Caveat: AudioConverter supported only for conversions through AudioConverterConvertBuffer.
Only Linear PCM formats are supported with 1 Frame per Packet and equal source & destination Channels per Frame.
Returns kAudioConverterErr_UnspecifiedError on failure and noErr (0) on success. Other return types not supported.
@Status Caveat
@Notes AudioConverter supported only for conversions through AudioConverterConvertBuffer.
Only Linear PCM formats are supported with 1 Frame per Packet and equal source & destination Channels per Frame.
Returns kAudioConverterErr_UnspecifiedError on failure and noErr (0) on success. Other return types not supported.
*/
OSStatus AudioConverterNew(const AudioStreamBasicDescription* inSourceFormat,
const AudioStreamBasicDescription* inDestinationFormat,
Expand Down Expand Up @@ -212,9 +213,9 @@ OSStatus AudioConverterSetProperty(AudioConverterRef inAudioConverter,
}

/**
@Status Caveat: Returns kAudioConverterErr_UnspecifiedError, kAudioConverterErr_InvalidInputSize or
kAudioConverterErr_InvalidOutputSize on failure and noErr (0) on success. Other return types not supported.
@Notes
@Status Caveat
@Notes Returns kAudioConverterErr_UnspecifiedError, kAudioConverterErr_InvalidInputSize or
kAudioConverterErr_InvalidOutputSize on failure and noErr (0) on success. Other return types not supported.
*/
OSStatus AudioConverterConvertBuffer(
AudioConverterRef inAudioConverter, UInt32 inInputDataSize, const void* inInputData, UInt32* ioOutputDataSize, void* outOutputData) {
Expand Down
3 changes: 3 additions & 0 deletions include/AudioToolbox/AudioConverterInternal.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
#include <wmcodecdsp.h>
#include <COMIncludes_End.h>

#import <Foundation/NSObject.h>
#import <CoreAudio/CoreAudioTypes.h>

using namespace Microsoft::WRL;
using namespace Microsoft::WRL::Wrappers;

Expand Down