Asks the delegate for the identifier of the sound to play when the object gains focus.
SDK
- tvOS 11.0+
Framework
- UIKit
Declaration
- (UIFocus Sound Identifier)soundIdentifierForFocusUpdateInContext:(UIFocus Update Context *)context;
Parameters
context
The context object associated with the update.
Return Value
The identifier of the sound to be played. Return nil
if you want to let the parent focus environment determine which sound to play.
Discussion
Use this method to return a custom sound when the focus environment object gains focus. Return UIFocus
to play the default system sound, or return UIFocus
to avoid playing a sound altogether. If you previously registered custom sounds using the register
method of UIFocus
, you may also return an identifier for a sound that you registered.
If you do not implement this method, the system assumes a nil
return value. If no ancestor environment defines a custom sound, the system plays the UIFocus
sound.
Important
You must register custom sounds before returning the associated identifiers from this method. Returning an identifier that is unknown to UIKit will result in an assertion failure and an immediate crash.