diff options
| author | Joel Fischer <joeljfischer@gmail.com> | 2016-08-11 10:56:14 -0400 |
|---|---|---|
| committer | Joel Fischer <joeljfischer@gmail.com> | 2016-08-11 10:56:14 -0400 |
| commit | 949e736f84a724a8b5e41a1f7eed7a41fdf46098 (patch) | |
| tree | 7b2db142aade57bb993057f6f0a39b113d4d45ae | |
| parent | f5f16b1830a4000216f0778c486ac0ad89f57fa2 (diff) | |
| download | sdl_ios-949e736f84a724a8b5e41a1f7eed7a41fdf46098.tar.gz | |
Fix a missed documentation TODO
| -rw-r--r-- | SmartDeviceLink/SDLStreamingMediaManager.h | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/SmartDeviceLink/SDLStreamingMediaManager.h b/SmartDeviceLink/SDLStreamingMediaManager.h index fb925b7ef..e2299e4eb 100644 --- a/SmartDeviceLink/SDLStreamingMediaManager.h +++ b/SmartDeviceLink/SDLStreamingMediaManager.h @@ -91,7 +91,7 @@ typedef void (^SDLStreamingEncryptionStartBlock)(BOOL success, BOOL encryption, - (instancetype)initWithProtocol:(SDLAbstractProtocol *)protocol displayCapabilities:(SDLDisplayCapabilities *)displayCapabilities; /** - * This method will attempt to start a streaming video session. It will set up iOS's video encoder, and call out to the head unit asking if it will start a video session. + * This method will attempt to start a streaming video session. It will set up iOS's video encoder, and call out to the head unit asking if it will start a video session. This will not use encryption. * * @warning If this method is called on an 8.0 device, it will assert (in debug), or return a failure immediately to your block (in release). * @@ -99,7 +99,12 @@ typedef void (^SDLStreamingEncryptionStartBlock)(BOOL success, BOOL encryption, */ - (void)startVideoSessionWithStartBlock:(SDLStreamingStartBlock)startBlock; -// TODO: Documentation +/** + * Start a video session either with with no encryption (the default), with authentication but no encryption (this will attempt a TLS authentication with the other side, but will not physically encrypt the data after that), or authentication and encryption, which will encrypt all video data being sent. + * + * @param encryptionFlag Whether and how much security to apply to the video session. + * @param startBlock A block that will be called with the result of attempting to start a video session + */ - (void)startVideoSessionWithTLS:(SDLEncryptionFlag)encryptionFlag startBlock:(SDLStreamingEncryptionStartBlock)startBlock; /** |