ContentShareController exposes methods for starting and stopping content share with a ContentShareSource. +The content represents a media steam to be shared in the meeting, such as screen capture or +media files. +Read content share guide for details.
+ContentShareObserver handles all callbacks related to the content share. +By implementing the callback functions and registering with ContentShareController.addContentShareObserver, +one can get notified with content share status events.
+ContentShareSource contains the media sources to attach to the content share
+ContentShareStatus indicates a status received regarding the content share.
+ContentShareStatusCode indicates the reason the content share event occurred.
+DefaultModality is a backwards compatible extension of the +attendee id (UUID string) and session token schemas (base 64 string). +It appends # to either strings, which indicates the modality +of the participant.
+DefaultScreenCaptureSource uses MediaProjection to create a VirtualDisplay to capture the +device screen. It will render the captured frames to a Surface provided by a SurfaceTextureCaptureSourceFactory.
+DefaultSurfaceTextureCaptureSource will provide a Surface which it will listen to and convert to VideoFrameTextureBuffer objects
@@ -215,6 +255,9 @@ObservableMetric represents filtered metrics that are intended to propagate to the top level observers. All metrics are measured over the past second.
diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.audio.activespeakerdetector/-active-speaker-detector-facade/index.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.audio.activespeakerdetector/-active-speaker-detector-facade/index.html index 8736f808..3c853125 100644 --- a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.audio.activespeakerdetector/-active-speaker-detector-facade/index.html +++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.audio.activespeakerdetector/-active-speaker-detector-facade/index.html @@ -40,7 +40,7 @@interface AudioVideoFacade : AudioVideoControllerFacade, RealtimeControllerFacade, DeviceController, VideoTileControllerFacade, ActiveSpeakerDetectorFacadeinterface AudioVideoFacade : AudioVideoControllerFacade, RealtimeControllerFacade, DeviceController, VideoTileControllerFacade, ActiveSpeakerDetectorFacade, ContentShareController
abstract fun addContentShareObserver(: ContentShareObserver): Unit
+Subscribe the given observer to content share events (sharing started and stopped).
+
+observer - : ContentShareObserver - The observer to be notified for events.
interface ContentShareController
+ContentShareController exposes methods for starting and stopping content share with a ContentShareSource. +The content represents a media steam to be shared in the meeting, such as screen capture or +media files. +Read content share guide for details.
+
+addContentShareObserver+ |
+
+ Subscribe the given observer to content share events (sharing started and stopped). +abstract fun addContentShareObserver(: ContentShareObserver): Unit |
+
+removeContentShareObserver+ |
+
+ Unsubscribe the given observer from content share events. +abstract fun removeContentShareObserver(: ContentShareObserver): Unit |
+
+startContentShare+ |
+
+ Start sharing the content of a given ContentShareSource. +abstract fun startContentShare(: ContentShareSource): Unit |
+
+stopContentShare+ |
+
+ Stop sharing the content of a ContentShareSource that previously started. +abstract fun stopContentShare(): Unit |
+
+AudioVideoFacade+ |
+
+interface AudioVideoFacade : AudioVideoControllerFacade, RealtimeControllerFacade, DeviceController, VideoTileControllerFacade, ActiveSpeakerDetectorFacade, ContentShareController |
+
+DefaultContentShareController+ |
+
+class DefaultContentShareController : ContentShareController |
+
abstract fun removeContentShareObserver(: ContentShareObserver): Unit
+Unsubscribe the given observer from content share events.
+
+observer - : ContentShareObserver - The observer to be removed for events.
abstract fun startContentShare(: ContentShareSource): Unit
+Start sharing the content of a given ContentShareSource.
+Once sharing has started successfully, ContentShareObserver.onContentShareStarted will +be invoked. If sharing fails or stops, ContentShareObserver.onContentShareStopped +will be invoked with ContentShareStatus as the cause.
+This will call VideoSource.addVideoSink on the provided source +and VideoSource.removeVideoSink on the previously provided source.
+Calling this function repeatedly will replace the previous ContentShareSource as the one being +transmitted.
+
+source - : ContentShareSource - The source of content to be shared.
abstract fun stopContentShare(): Unit
+Stop sharing the content of a ContentShareSource that previously started.
+Once the sharing stops successfully, ContentShareObserver.onContentShareStopped +will be invoked with status code ContentShareStatusCode.OK.
+ + diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-observer/index.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-observer/index.html new file mode 100644 index 00000000..8ef39637 --- /dev/null +++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-observer/index.html @@ -0,0 +1,39 @@ + + + +interface ContentShareObserver
+ContentShareObserver handles all callbacks related to the content share. +By implementing the callback functions and registering with ContentShareController.addContentShareObserver, +one can get notified with content share status events.
+
+onContentShareStarted+ |
+
+ Called when the content share has started. +This callback will be on the main thread. +abstract fun onContentShareStarted(): Unit |
+
+onContentShareStopped+ |
+
+ Called when the content is no longer shared with other attendees +with the reason provided in the status. +abstract fun onContentShareStopped(: ContentShareStatus): Unit |
+
abstract fun onContentShareStarted(): Unit
+Called when the content share has started. +This callback will be on the main thread.
+ + diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-observer/on-content-share-stopped.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-observer/on-content-share-stopped.html new file mode 100644 index 00000000..d9228e23 --- /dev/null +++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-observer/on-content-share-stopped.html @@ -0,0 +1,21 @@ + + + +abstract fun onContentShareStopped(: ContentShareStatus): Unit
+Called when the content is no longer shared with other attendees +with the reason provided in the status.
+If you no longer need the source producing frames, +most builders can stop the source after this callback is invoked.
+
+status - : ContentShareStatus - the reason why the content share has stopped
ContentShareSource()
+ContentShareSource contains the media sources to attach to the content share
+ + diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-source/index.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-source/index.html new file mode 100644 index 00000000..b21c2b63 --- /dev/null +++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-source/index.html @@ -0,0 +1,39 @@ + + + +open class ContentShareSource
+ContentShareSource contains the media sources to attach to the content share
+
+<init>+ |
+
+ ContentShareSource contains the media sources to attach to the content share +ContentShareSource() |
+
+videoSource+ |
+
+open var videoSource: VideoSource? |
+
open var videoSource: VideoSource?
+
+
diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-status-code/-o-k.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-status-code/-o-k.html
new file mode 100644
index 00000000..f5aa7b84
--- /dev/null
+++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-status-code/-o-k.html
@@ -0,0 +1,15 @@
+
+
+
+OK
+No failure.
+ + diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-status-code/-video-service-failed.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-status-code/-video-service-failed.html new file mode 100644 index 00000000..c6e38640 --- /dev/null +++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-status-code/-video-service-failed.html @@ -0,0 +1,16 @@ + + + +VideoServiceFailed
+Content share video connection is in an unrecoverable failed state. +Restart content share connection when this error is encountered.
+ + diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-status-code/index.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-status-code/index.html new file mode 100644 index 00000000..05c15bf7 --- /dev/null +++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-content-share-status-code/index.html @@ -0,0 +1,36 @@ + + + +enum class ContentShareStatusCode
+ContentShareStatusCode indicates the reason the content share event occurred.
+
+OK+ |
+
+ No failure. + |
+
+VideoServiceFailed+ |
+
+ Content share video connection is in an unrecoverable failed state. +Restart content share connection when this error is encountered. + |
+
ContentShareStatus(: ContentShareStatusCode)
+ContentShareStatus indicates a status received regarding the content share.
+
+statusCode - : ContentShareStatusCode - Additional details for the status
data class ContentShareStatus
+ContentShareStatus indicates a status received regarding the content share.
+
+statusCode - : ContentShareStatusCode - Additional details for the status
+<init>+ |
+
+ ContentShareStatus indicates a status received regarding the content share. +ContentShareStatus(: ContentShareStatusCode) |
+
+statusCode+ |
+
+ : ContentShareStatusCode - Additional details for the status +val statusCode: ContentShareStatusCode |
+
val statusCode: ContentShareStatusCode
+: ContentShareStatusCode - Additional details for the status
+ + diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-default-content-share-controller/-init-.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-default-content-share-controller/-init-.html new file mode 100644 index 00000000..91760fb1 --- /dev/null +++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-default-content-share-controller/-init-.html @@ -0,0 +1,14 @@ + + + +DefaultContentShareController(: Logger, : ContentShareVideoClientController)
+
+
diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-default-content-share-controller/add-content-share-observer.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-default-content-share-controller/add-content-share-observer.html
new file mode 100644
index 00000000..f2e89ef1
--- /dev/null
+++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/-default-content-share-controller/add-content-share-observer.html
@@ -0,0 +1,18 @@
+
+
+
+fun addContentShareObserver(: ContentShareObserver): Unit
+Subscribe the given observer to content share events (sharing started and stopped).
+
+observer - : ContentShareObserver - The observer to be notified for events.
class DefaultContentShareController : ContentShareController
+
+<init>+ |
+
+DefaultContentShareController(: Logger, : ContentShareVideoClientController) |
+
+addContentShareObserver+ |
+
+ Subscribe the given observer to content share events (sharing started and stopped). +fun addContentShareObserver(: ContentShareObserver): Unit |
+
+removeContentShareObserver+ |
+
+ Unsubscribe the given observer from content share events. +fun removeContentShareObserver(: ContentShareObserver): Unit |
+
+startContentShare+ |
+
+ Start sharing the content of a given ContentShareSource. +fun startContentShare(: ContentShareSource): Unit |
+
+stopContentShare+ |
+
+ Stop sharing the content of a ContentShareSource that previously started. +fun stopContentShare(): Unit |
+
fun removeContentShareObserver(: ContentShareObserver): Unit
+Unsubscribe the given observer from content share events.
+
+observer - : ContentShareObserver - The observer to be removed for events.
fun startContentShare(: ContentShareSource): Unit
+Start sharing the content of a given ContentShareSource.
+Once sharing has started successfully, ContentShareObserver.onContentShareStarted will +be invoked. If sharing fails or stops, ContentShareObserver.onContentShareStopped +will be invoked with ContentShareStatus as the cause.
+This will call VideoSource.addVideoSink on the provided source +and VideoSource.removeVideoSink on the previously provided source.
+Calling this function repeatedly will replace the previous ContentShareSource as the one being +transmitted.
+
+source - : ContentShareSource - The source of content to be shared.
fun stopContentShare(): Unit
+Stop sharing the content of a ContentShareSource that previously started.
+Once the sharing stops successfully, ContentShareObserver.onContentShareStopped +will be invoked with status code ContentShareStatusCode.OK.
+ + diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/index.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/index.html new file mode 100644 index 00000000..57807ac3 --- /dev/null +++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.contentshare/index.html @@ -0,0 +1,69 @@ + + + +
+ContentShareController+ |
+
+ ContentShareController exposes methods for starting and stopping content share with a ContentShareSource. +The content represents a media steam to be shared in the meeting, such as screen capture or +media files. +Read content share guide for details. +interface ContentShareController |
+
+ContentShareObserver+ |
+
+ ContentShareObserver handles all callbacks related to the content share. +By implementing the callback functions and registering with ContentShareController.addContentShareObserver, +one can get notified with content share status events. +interface ContentShareObserver |
+
+ContentShareSource+ |
+
+ ContentShareSource contains the media sources to attach to the content share +open class ContentShareSource |
+
+ContentShareStatus+ |
+
+ ContentShareStatus indicates a status received regarding the content share. +data class ContentShareStatus |
+
+ContentShareStatusCode+ |
+
+ ContentShareStatusCode indicates the reason the content share event occurred. +enum class ContentShareStatusCode |
+
+DefaultContentShareController+ |
+
+class DefaultContentShareController : ContentShareController |
+
contentShareVideoSendBitrate
+Sum of total bitrate across all send streams
+ + diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/content-share-video-send-fps.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/content-share-video-send-fps.html new file mode 100644 index 00000000..357a0eb1 --- /dev/null +++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/content-share-video-send-fps.html @@ -0,0 +1,15 @@ + + + +contentShareVideoSendFps
+Average send FPS across all send streams
+ + diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/content-share-video-send-packet-loss-percent.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/content-share-video-send-packet-loss-percent.html new file mode 100644 index 00000000..b6fd3ef7 --- /dev/null +++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/content-share-video-send-packet-loss-percent.html @@ -0,0 +1,15 @@ + + + +contentShareVideoSendPacketLossPercent
+Percentage of video packets lost from client to server across all send streams
+ + diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/content-share-video-send-rtt-ms.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/content-share-video-send-rtt-ms.html new file mode 100644 index 00000000..7cd509f8 --- /dev/null +++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/content-share-video-send-rtt-ms.html @@ -0,0 +1,15 @@ + + + +contentShareVideoSendRttMs
+Round trip time of packets sent from client to server
+ + diff --git a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/index.html b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/index.html index 1bdecfa4..a5854c32 100644 --- a/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/index.html +++ b/docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/index.html @@ -94,6 +94,51 @@Percentage of video packets lost from server to client across all receive streams
Sum of total bitrate across all send streams
+Percentage of video packets lost from client to server across all send streams
+Average send FPS across all send streams
+Round trip time of packets sent from client to server
+
+isContentShareMetric+ |
+
+ Determine if the metric is for content share stream +fun isContentShareMetric(): Boolean |
+
fun isContentShareMetric(): Boolean
+Determine if the metric is for content share stream
+