1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
//
// SDLStreamingAudioLifecycleManager.h
// SmartDeviceLink
//
// Created by Joel Fischer on 6/19/18.
// Copyright © 2018 smartdevicelink. All rights reserved.
//
#import <Foundation/Foundation.h>
#import "SDLHMILevel.h"
#import "SDLProtocolDelegate.h"
#import "SDLStreamingAudioManagerType.h"
#import "SDLStreamingMediaManagerConstants.h"
@class SDLAudioStreamManager;
@class SDLConfiguration;
@class SDLProtocol;
@class SDLStateMachine;
@class SDLSystemCapabilityManager;
@class SDLEncryptionConfiguration;
@protocol SDLConnectionManagerType;
NS_ASSUME_NONNULL_BEGIN
@interface SDLStreamingAudioLifecycleManager : NSObject <SDLProtocolDelegate, SDLStreamingAudioManagerType>
@property (nonatomic, strong, readonly) SDLAudioStreamManager *audioTranscodingManager;
@property (strong, nonatomic, readonly) SDLStateMachine *audioStreamStateMachine;
@property (strong, nonatomic, readonly) SDLAudioStreamManagerState *currentAudioStreamState;
@property (strong, nonatomic, readonly) SDLStateMachine *appStateMachine;
@property (copy, nonatomic, nullable) SDLHMILevel hmiLevel;
/**
* Whether or not the audio session is connected.
*/
@property (assign, nonatomic, readonly, getter=isAudioConnected) BOOL audioConnected;
/**
* Whether or not the audio session is encrypted. This may be different than the requestedEncryptionType.
*/
@property (assign, nonatomic, readonly, getter=isAudioEncrypted) BOOL audioEncrypted;
/// Whether or not video/audio streaming is supported
/// @discussion If connected to a module pre-SDL v4.5 there is no way to check if streaming is supported so `YES` is returned by default even though the module may NOT support video/audio streaming.
@property (assign, nonatomic, readonly, getter=isStreamingSupported) BOOL streamingSupported;
/**
* The requested encryption type when a session attempts to connect. This setting applies to both video and audio sessions.
*
* DEFAULT: SDLStreamingEncryptionFlagAuthenticateAndEncrypt
*/
@property (assign, nonatomic) SDLStreamingEncryptionFlag requestedEncryptionType;
- (instancetype)init NS_UNAVAILABLE;
/// Create a new streaming audio manager for navigation and projection apps with a specified configuration.
/// @param connectionManager The pass-through for RPCs
/// @param configuration This session's configuration
/// @param systemCapabilityManager The system capability manager object for reading window capabilities
- (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager configuration:(SDLConfiguration *)configuration systemCapabilityManager:(nullable SDLSystemCapabilityManager *)systemCapabilityManager NS_DESIGNATED_INITIALIZER;
/**
* Start the manager with a completion block that will be called when startup completes. This is used internally. To use an SDLStreamingMediaManager, you should use the manager found on `SDLManager`.
*/
- (void)startWithProtocol:(SDLProtocol *)protocol;
/// This method is used internally to stop the manager when the device disconnects from the module. Since there is no connection between the device and the module there is no point in sending an end audio service control frame as the module will never receive the request.
- (void)stop;
/// This method is used internally to stop the manager when audio needs to be stopped on the secondary transport. The primary transport is still open.
/// 1. Since the primary transport is still open, we will not reset the `hmiLevel` since we can still get notifications from the module with the updated HMI status on the primary transport.
/// 2. We need to send an end audio service control frame to the module to ensure that the audio session is shut down correctly. In order to do this the protocol must be kept open and only destroyed after the module ACKs or NAKs our end audio service request.
/// @param audioEndedCompletionHandler Called when the module ACKs or NAKs to the request to end the audio service.
- (void)endAudioServiceWithCompletionHandler:(void (^)(void))audioEndedCompletionHandler;
/// This method is used internally to stop audio streaming when the secondary transport has been closed due to an connection error. The primary transport is still open.
/// 1. Since the transport has been closed, we can not send an end audio service control frame to the module.
/// 2. Since the primary transport is still open, we will not reset the `hmiLevel`. This lets us resume audio streaming if the secondary transport can be reestablished during the same app session.
- (void)secondaryTransportDidDisconnect;
/**
* This method receives PCM audio data and will attempt to send that data across to the head unit for immediate playback
*
* @param audioData The data in PCM audio format, to be played
*
* @return Whether or not the data was successfully sent.
*/
- (BOOL)sendAudioData:(NSData *)audioData;
@end
NS_ASSUME_NONNULL_END
|
