Evaluates equality for the specified parts of two audio format descriptions.
SDKs
- iOS 4.0+
- macOS 10.7+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 6.0+
Framework
- Core Media
Declaration
Boolean CMAudioFormatDescriptionEqual(CMAudio Format Description Ref formatDescription, CMAudio Format Description Ref otherFormatDescription, CMAudio Format Description Mask equalityMask, CMAudio Format Description Mask *equalityMaskOut);
Parameters
desc1
The
CMAudio
being compared.Format Description desc2
The
CMAudio
to which it is being compared.Format Description equalityMask
Mask specifying which parts of the descriptions to compare.
equalityMaskOut
Pointer to variable that will be written with the results that represent the parts that are equal. Can be
NULL
.
Return Value
The result of the comparison. True if all parts in which the caller is interested are equal. False if any of the parts in which the caller is interested are not equal.
Discussion
Bits in equality
specify the caller's interest in the equality of various parts of the descriptions. Bits set and returned in equality
represent the subset of those parts that are equal. If there is any sort of error that prevents the comparison from occurring, false will be returned, and all bits in equality
will be cleared. If you pass k
in equalityMask, and NULL
for equality
, this API is equivalent to CFEqual(desc1, desc2)
.