Classes Reference


                    
                    
                    DefaultEventAnalyticsController

Declaration

Swift

@objcMembers
public class DefaultEventAnalyticsController : NSObject, EventAnalyticsController


                    
                    
                    MeetingHistoryEvent

Declaration

Swift

@objcMembers
public class MeetingHistoryEvent : NSObject


                    
                    
                    SDKEvent

SDKEvent defines event that composes of name of event and attribute to describe the event

Declaration

Swift

@objcMembers
public class SDKEvent : NSObject


                    
                    
                    AudioVideoConfiguration

AudioVideoConfiguration represents the configuration to be used for audio and video during a meeting session.

Declaration

Swift

@objcMembers
public class AudioVideoConfiguration : NSObject


                    
                    
                    DefaultAudioVideoController

Declaration

Swift

@objcMembers
public class DefaultAudioVideoController : NSObject, AudioVideoControllerFacade


                    
                    
                    DefaultAudioVideoFacade

Declaration

Swift

@objcMembers
public class DefaultAudioVideoFacade : NSObject, AudioVideoFacade


                    
                    
                    DefaultActiveSpeakerDetector

Declaration

Swift

@objcMembers
public class DefaultActiveSpeakerDetector : NSObject, ActiveSpeakerDetectorFacade, RealtimeObserver


                    
                    
                    DefaultActiveSpeakerPolicy

Declaration

Swift

@objcMembers
public class DefaultActiveSpeakerPolicy : NSObject, ActiveSpeakerPolicy


                    
                    
                    IntervalScheduler

IntervalScheduler calls the callback every intervalMs milliseconds.

Declaration

Swift

@objcMembers
public class IntervalScheduler : NSObject, Scheduler


                    
                    
                    ContentShareSource

ContentShareSource contains the media sources to attach to the content share

Declaration

Swift

@objcMembers
public class ContentShareSource : NSObject


                    
                    
                    ContentShareStatus

ContentShareStatus indicates a status received regarding the content share.

Declaration

Swift

@objcMembers
public class ContentShareStatus : NSObject


                    
                    
                    DefaultContentShareController

Declaration

Swift

@objcMembers
public class DefaultContentShareController : NSObject, ContentShareController


                    
                    
                    InAppScreenCaptureSource

InAppScreenCaptureSource is used to share screen capture within the app. When the app is in the background, there is no sample sent to handler, and screen sharing is paused. InAppScreenCaptureSource is only available on iOS 11+ because of RPScreenRecorder.startCapture(handler:completionHandler:) method. InAppScreenCaptureSource does not support rotation while it’s in progress.

Declaration

Swift

@available(iOS 11.0, *)
@objcMembers
public class InAppScreenCaptureSource : NSObject, VideoCaptureSource


                    
                    
                    ReplayKitSource

ReplayKitSource repackages CMSampleBuffer objects from ReplayKit into SDK usable VideoFrame objects. It currently supports resending video frames to maintain a minimum frame rate.

It does not directly contain any system library calls that actually captures the screen. Builders can use InAppScreenCaptureSourceto share screen from only their application. For device level screen broadcast, take a look at the SampleHandler in AmazonChimeSDKDemoBroadcast.

Declaration

Swift

@objcMembers
public class ReplayKitSource : VideoSource


                    
                    
                    AttendeeInfo

Declaration

Swift

@objcMembers
public class AttendeeInfo : NSObject, Comparable


                    
                    
                    DataMessage

Data message received from server.

Declaration

Swift

@objcMembers
public class DataMessage : NSObject


                    
                    
                    SignalUpdate

Declaration

Swift

@objcMembers
public class SignalUpdate : NSObject


                    
                    
                    VolumeUpdate

Declaration

Swift

@objcMembers
public class VolumeUpdate : NSObject


                    
                    
                    Transcript

See Using Amazon Chime SDK live transcription developer guide for details about transcription message types and data guidelines

Declaration

Swift

@objcMembers
public class Transcript : NSObject, TranscriptEvent


                    
                    
                    TranscriptAlternative

See Using Amazon Chime SDK live transcription developer guide for details about transcription message types and data guidelines

Declaration

Swift

@objcMembers
public class TranscriptAlternative : NSObject


                    
                    
                    TranscriptEntity

See Using Amazon Chime SDK live transcription developer guide for details about transcription message types and data guidelines

Declaration

Swift

@objcMembers
public class TranscriptEntity : NSObject


                    
                    
                    TranscriptItem

See Using Amazon Chime SDK live transcription developer guide for details about transcription message types and data guidelines

Declaration

Swift

@objcMembers
public class TranscriptItem : NSObject


                    
                    
                    TranscriptLanguageWithScore

See Using Amazon Chime SDK live transcription developer guide for details about transcription message types and data guidelines

Declaration

Swift

@objcMembers
public class TranscriptLanguageWithScore : NSObject


                    
                    
                    TranscriptResult

See Using Amazon Chime SDK live transcription developer guide for details about transcription message types and data guidelines

Declaration

Swift

@objcMembers
public class TranscriptResult : NSObject


                    
                    
                    TranscriptionStatus

See Using Amazon Chime SDK live transcription developer guide for details about transcription message types and data guidelines

Declaration

Swift

@objcMembers
public class TranscriptionStatus : NSObject, TranscriptEvent


                    
                    
                    DefaultVideoRenderView

Declaration

Swift

@objcMembers
@MainActor
public class DefaultVideoRenderView : UIImageView, VideoRenderView


                    
                    
                    DefaultVideoTile

Declaration

Swift

@objcMembers
public class DefaultVideoTile : NSObject, VideoTile


                    
                    
                    DefaultVideoTileController

Declaration

Swift

@objcMembers
public class DefaultVideoTileController : NSObject, VideoTileController


                    
                    
                    LocalVideoConfiguration

Configuration for a local video or content share to be sent

Declaration

Swift

@objcMembers
public class LocalVideoConfiguration : NSObject


                    
                    
                    RemoteVideoSource

A video source available in the current meeting. RemoteVideoSource need to be consistent between remoteVideoSourcesDidBecomeAvailable and updateVideoSourceSubscriptions as they are used as keys in maps that may be updated. I.e. when setting up a map for updateVideoSourceSubscriptions do not construct RemoteVideoSource yourselves or the configuration may or may not be updated.

Declaration

Swift

@objcMembers
public class RemoteVideoSource : NSObject


                    
                    
                    VideoBitrateConstants

video bitrates for regular and high-resolution meetings

Declaration

Swift

@objc
public class VideoBitrateConstants : NSObject


                    
                    
                    VideoFrame

VideoFrame is a class which contains a VideoFrameBuffer and metadata necessary for transmission. Typically produced via a VideoSource and consumed via a VideoSink

Declaration

Swift

@objcMembers
public class VideoFrame : NSObject


                    
                    
                    VideoFramePixelBuffer

VideoFramePixelBuffer is a buffer which contains a single video frame in the form of CVPixelBuffer.

Declaration

Swift

@objcMembers
public class VideoFramePixelBuffer : NSObject, VideoFrameBuffer


                    
                    
                    VideoResolution

Customizable video resolution parameters for a remote video source.

Declaration

Swift

@objc
public class VideoResolution : NSObject


                    
                    
                    VideoSubscriptionConfiguration

Configuration for a specific video source. The values are intentionally mutable so that a map of all current configurations can be kept and updated as needed.

VideoSubscriptionConfiguration is used to contain the priority and resolution of remote video sources and content share to be received

Declaration

Swift

@objcMembers
public class VideoSubscriptionConfiguration : NSObject


                    
                    
                    VideoTileState

VideoTileState encapsulates the state of a VideoTile.

Declaration

Swift

@objcMembers
public class VideoTileState : NSObject


                    
                    
                    BackgroundFilterProcessor

BackgroundFilterProcessor is a processor that uses SegmentationProcessor to process a frame by creating the alpha mask of the foreground image and blending the mask with the input image which is then rendered on top of a background image.

Declaration

Swift

public class BackgroundFilterProcessor


                    
                    
                    NoopSegmentationProcessor

NoopSegmentationProcessor is a processor that does nothing except pass image frames in and out. This is used as a placeholder for implementations of SegmentationProcessor that cannot be initialized.

Declaration

Swift

public class NoopSegmentationProcessor : SegmentationProcessor


                    
                    
                    BackgroundBlurConfiguration

Declaration

Swift

@objcMembers
public class BackgroundBlurConfiguration : NSObject


                    
                    
                    BackgroundBlurVideoFrameProcessor

BackgroundBlurVideoFrameProcessor is a processor which receives video frames via VideoSource and then applies Gaussian blur to each video frame and renders the foreground on top of the blurred image. Gaussian blur is applied using built in CIGaussianBlur CIFilter.

Declaration

Swift

@objcMembers
public class BackgroundBlurVideoFrameProcessor : NSObject, VideoSource, VideoSink


                    
                    
                    BackgroundReplacementConfiguration

Declaration

Swift

@objcMembers
public class BackgroundReplacementConfiguration : NSObject


                    
                    
                    BackgroundReplacementVideoFrameProcessor

BackgroundReplacementVideoFrameProcessor is a processor which receives video frames via VideoSource and then creates the foreground image which is rendered on top of a background image.

Declaration

Swift

@objcMembers
public class BackgroundReplacementVideoFrameProcessor : NSObject, VideoSource, VideoSink


                    
                    
                    DefaultCameraCaptureSource

Declaration

Swift

@objcMembers
public class DefaultCameraCaptureSource : NSObject, CameraCaptureSource

extension DefaultCameraCaptureSource: AVCaptureVideoDataOutputSampleBufferDelegate


                    
                    
                    VideoCaptureFormat

VideoCaptureFormatdescribes a given capture format that may be possible to apply to a VideoCaptureSource. Note that VideoCaptureSource implementations may ignore or adjust unsupported values.

Declaration

Swift

@objcMembers
public class VideoCaptureFormat : NSObject


                    
                    
                    DefaultDeviceController

Declaration

Swift

@objcMembers
public class DefaultDeviceController : NSObject, DeviceController


                    
                    
                    MediaDevice

MediaDevice represents an IOS audio/video device.

Declaration

Swift

@objcMembers
public class MediaDevice : NSObject


                    
                    
                    DefaultEventReporter

Declaration

Swift

@objcMembers
public class DefaultEventReporter : NSObject, EventReporter


                    
                    
                    DefaultMeetingEventReporterFactory

Declaration

Swift

@objcMembers
public class DefaultMeetingEventReporterFactory : EventReporterFactory


                    
                    
                    IngestionConfiguration

IngestionConfiguration defines the configuration needed for ingestion service. This will be passed down to DefaultEventReporter

Declaration

Swift

@objcMembers
public class IngestionConfiguration : NSObject


                    
                    
                    IngestionConfigurationBuilder

IngestionConfigurationBuilder helps to create IngestionConfiguration by providing builder pattern.

Declaration

Swift

@objcMembers
public class IngestionConfigurationBuilder : NSObject


                    
                    
                    IngestionEvent

Event data that will be send to the ingestion server

Declaration

Swift

@objcMembers
public class IngestionEvent : NSObject, Codable


                    
                    
                    IngestionEventConverter

IngestionEventConverter converts data from payload into MeetingEventItem/DirtyEventItemor vice versa.

Declaration

Swift

@objcMembers
public class IngestionEventConverter : NSObject


                    
                    
                    IngestionPayload

Declaration

Swift

@objcMembers
public class IngestionPayload : NSObject, Codable


                    
                    
                    IngestionRecord

IngestionRecord is the format of data that will be consumed on the ingestion server.

Declaration

Swift

@objcMembers
public class IngestionRecord : NSObject, Codable


                    
                    
                    MeetingEventClientConfiguration

MeetingEventClientConfiguration is one type of EventClientConfiguration that contains information about the meeting

Declaration

Swift

@objcMembers
public class MeetingEventClientConfiguration : NSObject, EventClientConfiguration


                    
                    
                    NoopEventReporterFactory

Declaration

Swift

@objcMembers
public class NoopEventReporterFactory : EventReporterFactory


                    
                    
                    DefaultRealtimeController

Declaration

Swift

@objcMembers
public class DefaultRealtimeController : NSObject, RealtimeControllerFacade


                    
                    
                    CreateAttendeeResponse

Declaration

Swift

@objcMembers
public class CreateAttendeeResponse : NSObject


                    
                    
                    Attendee

Declaration

Swift

@objcMembers
public class Attendee : NSObject


                    
                    
                    CreateMeetingResponse

Declaration

Swift

@objcMembers
public class CreateMeetingResponse : NSObject


                    
                    
                    Meeting

Declaration

Swift

@objcMembers
public class Meeting : NSObject


                    
                    
                    MediaPlacement

Declaration

Swift

@objcMembers
public class MediaPlacement : NSObject


                    
                    
                    MeetingFeatures

Declaration

Swift

@objcMembers
public class MeetingFeatures : NSObject


                    
                    
                    DefaultMeetingSession

Declaration

Swift

@objcMembers
public class DefaultMeetingSession : NSObject, MeetingSession


                    
                    
                    MeetingSessionConfiguration

MeetingSessionConfiguration contains the information necessary to start a session. Constructs a MeetingSessionConfiguration with a chime:CreateMeetingResponse and chime:CreateAttendeeResponse response and optional custom URLRewriter that will rewrite urls given to new urls.

Declaration

Swift

@objcMembers
public class MeetingSessionConfiguration : NSObject


                    
                    
                    MeetingSessionCredentials

MeetingSessionCredentials includes the credentials used to authenticate. the attendee on the meeting

Declaration

Swift

@objcMembers
public class MeetingSessionCredentials : NSObject, Codable


                    
                    
                    MeetingSessionStatus

MeetingSessionStatus indicates a status received regarding the session.

Declaration

Swift

@objcMembers
public class MeetingSessionStatus : NSObject


                    
                    
                    MeetingSessionURLs

MeetingSessionURLs contains the URLs that will be used to reach the meeting service.

Declaration

Swift

@objcMembers
public class MeetingSessionURLs : NSObject, Codable


                    
                    
                    URLRewriterUtils

URLRewriterUtils is class that defines default Url rewrite behavior

Declaration

Swift

@objcMembers
public class URLRewriterUtils : NSObject


                    
                    
                    DefaultModality

DefaultModality is a backwards compatible extension of the attendee id (UUID string) and session token schemas (base 64 string). It appends # to either string, which indicates the modality of the participant.

For example, attendeeId: “abcdefg” contentAttendeeId: “abcdefg#content” DefaultModality(id: contentAttendeeId).base: “abcdefg” DefaultModality(id: contentAttendeeId).modality: “content” DefaultModality(id: contentAttendeeId).isOfType(type: .content): true

Declaration

Swift

@objcMembers
public class DefaultModality : NSObject


                    
                    
                    Versioning

Declaration

Swift

@objcMembers
public class Versioning : NSObject


                    
                    
                    ConsoleLogger

ConsoleLogger writes logs with console.

// working with the ConsoleLogger
let logger = new ConsoleLogger("demo"); //default level is LogLevel.INFO
logger.info("info");
logger.debug("debug");
logger.fault("fault");
logger.error("error");

// setting logging levels
let logger = new ConsoleLogger("demo", .INFO);
logger.debug("debug"); // does not print
logger.setLogLevel(LogLevel.DEBUG)
logger.debug("debug"); // print

Declaration

Swift

@objcMembers
public class ConsoleLogger : NSObject, Logger