AVAudioSession.Notifications.ObserveRouteChange Method

  • Reference

Definition

Namespace:
AVFoundation
Assembly:
Xamarin.iOS.dll

Overloads

ObserveRouteChange(EventHandler<AVAudioSessionRouteChangeEventArgs>)

Strongly typed notification for the RouteChangeNotification constant.
ObserveRouteChange(NSObject, EventHandler<AVAudioSessionRouteChangeEventArgs>)

Strongly typed notification for the RouteChangeNotification constant.

ObserveRouteChange(EventHandler<AVAudioSessionRouteChangeEventArgs>)

Strongly typed notification for the RouteChangeNotification constant.

public static Foundation.NSObject ObserveRouteChange (EventHandler<AVFoundation.AVAudioSessionRouteChangeEventArgs> handler);
static member ObserveRouteChange : EventHandler<AVFoundation.AVAudioSessionRouteChangeEventArgs> -> Foundation.NSObject

Parameters

handler
EventHandler<AVAudioSessionRouteChangeEventArgs>

Method to invoke when the notification is posted.

Returns

NSObject

Token object that can be used to stop receiving notifications by either disposing it or passing it to RemoveObservers(IEnumerable<NSObject>)

Remarks

The following example shows how developers can use this method in their code:

//
// Lambda style
//

// listening
notification = AVAudioSession.Notifications.ObserveRouteChange ((sender, args) => {
    /* Access strongly typed args */
    Console.WriteLine ("Notification: {0}", args.Notification);

    Console.WriteLine ("Reason", args.Reason);
    Console.WriteLine ("PreviousRoute", args.PreviousRoute);
});

// To stop listening:
notification.Dispose ();

//
//Method style
//
NSObject notification;
void Callback (object sender, AVFoundation.AVAudioSessionRouteChangeEventArgs args)
{
    // Access strongly typed args
    Console.WriteLine ("Notification: {0}", args.Notification);

    Console.WriteLine ("Reason", args.Reason);
    Console.WriteLine ("PreviousRoute", args.PreviousRoute);
}

void Setup ()
{
    notification = AVAudioSession.Notifications.ObserveRouteChange (Callback);
}

void Teardown ()
{
    notification.Dispose ();
}

Applies to

ObserveRouteChange(NSObject, EventHandler<AVAudioSessionRouteChangeEventArgs>)

Strongly typed notification for the RouteChangeNotification constant.

public static Foundation.NSObject ObserveRouteChange (Foundation.NSObject objectToObserve, EventHandler<AVFoundation.AVAudioSessionRouteChangeEventArgs> handler);
static member ObserveRouteChange : Foundation.NSObject * EventHandler<AVFoundation.AVAudioSessionRouteChangeEventArgs> -> Foundation.NSObject

Parameters

objectToObserve
NSObject

The specific object to observe.

handler
EventHandler<AVAudioSessionRouteChangeEventArgs>

The handler that responds to the notification when it occurs.

Returns

NSObject

Token object that can be used to stop receiving notifications by either disposing it or passing it to RemoveObservers(IEnumerable<NSObject>)

Remarks

This method can be used to subscribe for RouteChangeNotification notifications.

// Listen to all notifications posted for any object
var token = AVAudioSession.Notifications.ObserveRouteChange ((notification) => {
	Console.WriteLine ("Observed RouteChangeNotification!");
};

// Listen to all notifications posted for a single object
var token = AVAudioSession.Notifications.ObserveRouteChange (objectToObserve, (notification) => {
	Console.WriteLine ($"Observed RouteChangeNotification for {nameof (objectToObserve)}!");
};

// Stop listening for notifications
token.Dispose ();

Applies to