Instance Property

active

A Boolean value that states whether the channel is sampling the microphone.

Declaration

iOS, tvOS
@property(assign, getter=isActive, nonatomic) BOOL active;
macOS
@property(assign, getter=isActive, atomic) BOOL active;

Discussion

When active is YES, the voice chat samples the microphone and transmits the voice data to other players connected to the channel. Default value is NO.

Only one GKVoiceChat object is allowed to sample the microphone at any given time. When your game sets the active property to YES on a voice chat object, the previous voice chat object that owned the microphone (if there was one) sets its active property to NO.