Add voice broadcast state event

Config/AppConfiguration.swift

@@ -30,9 +30,10 @@ class AppConfiguration: CommonConfiguration {
         // Enable CallKit for app
         MXKAppSettings.standard()?.isCallKitEnabled = true
 
-        // Get modular widget events in rooms histories
+        // Get additional events (modular widget, voice broadcast...)
         MXKAppSettings.standard()?.addSupportedEventTypes([kWidgetMatrixEventTypeString,
-                                                           kWidgetModularEventTypeString])
+                                                           kWidgetModularEventTypeString,
+                                                           VoiceBroadcastSettings.eventType])
 
         // Hide undecryptable messages that were sent while the user was not in the room
         MXKAppSettings.standard()?.hidePreJoinedUndecryptableEvents = true

Config/BuildSettings.swift

@@ -404,6 +404,10 @@ final class BuildSettings: NSObject {
     static let defaultTileServerMapStyleURL = URL(string: "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx")!
 
     static let locationSharingEnabled = true
+
+    // MARK: - Voice Broadcast
+    static let voiceBroadcastEnabled = false
+    static let voiceBroadcastChunkLength: Int = 600
 
     // MARK: - MXKAppSettings
     static let enableBotCreation: Bool = false

Riot/Assets/Images.xcassets/Room/Actions/action_live.imageset/Contents.json

@@ -0,0 +1,23 @@
+{
+  "images" : [
+    {
+      "filename" : "action_live.png",
+      "idiom" : "universal",
+      "scale" : "1x"
+    },
+    {
+      "filename" : "[email protected]",
+      "idiom" : "universal",
+      "scale" : "2x"
+    },
+    {
+      "filename" : "[email protected]",
+      "idiom" : "universal",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Riot/Generated/Images.swift

@@ -177,6 +177,7 @@ internal class Asset: NSObject {
     internal static let peopleFloatingAction = ImageAsset(name: "people_floating_action")
     internal static let actionCamera = ImageAsset(name: "action_camera")
     internal static let actionFile = ImageAsset(name: "action_file")
+    internal static let actionLive = ImageAsset(name: "action_live")
     internal static let actionLocation = ImageAsset(name: "action_location")
     internal static let actionMediaLibrary = ImageAsset(name: "action_media_library")
     internal static let actionPoll = ImageAsset(name: "action_poll")

Riot/Modules/Room/CellData/RoomBubbleCellData.h

@@ -36,7 +36,8 @@ typedef NS_ENUM(NSInteger, RoomBubbleCellDataTag)
     RoomBubbleCellDataTagRoomCreationIntro,
     RoomBubbleCellDataTagPoll,
     RoomBubbleCellDataTagLocation,
-    RoomBubbleCellDataTagLiveLocation
+    RoomBubbleCellDataTagLiveLocation,
+    RoomBubbleCellDataTagVoiceBroadcast
 };
 
 /**

Riot/Modules/Room/CellData/RoomBubbleCellData.m

@@ -182,6 +182,13 @@ - (instancetype)initWithEvent:(MXEvent *)event andRoomState:(MXRoomState *)roomS
                         // Show timestamps always on right
                         self.displayTimestampForSelectedComponentOnLeftWhenPossible = NO;
                     }
+                } else if ([event.type isEqualToString:VoiceBroadcastSettings.eventType]) {
+                    self.tag = RoomBubbleCellDataTagVoiceBroadcast;
+                    self.collapsable = NO;
+                    self.collapsed = NO;
+
+                    MXLogDebug(@"VB incoming initWithEvent")
+                    break;
                 }
 
                 break;
@@ -271,42 +278,44 @@ - (NSAttributedString*)attributedTextMessageWithoutPositioningSpace
 
 - (BOOL)hasNoDisplay
 {
-    if (self.tag == RoomBubbleCellDataTagKeyVerificationNoDisplay)
-    {
-        return YES;
-    }
-
-    if (self.tag == RoomBubbleCellDataTagRoomCreationIntro)
-    {
-        return NO;
-    }
-
-    if (self.tag == RoomBubbleCellDataTagPoll)
-    {
-        if (self.events.lastObject.isEditEvent) {
-            return YES;
-        }
-
-        return NO;
-    }
-
-    if (self.tag == RoomBubbleCellDataTagLocation)
-    {
-        return NO;
-    }
+    BOOL hasNoDisplay = YES;
 
-    if (self.tag == RoomBubbleCellDataTagLiveLocation)
+    switch (self.tag)
     {
-        // If the summary does not exist don't show the cell
-        if (!self.beaconInfoSummary)
-        {
-            return YES;
-        }
-
-        return NO;
+        case RoomBubbleCellDataTagKeyVerificationNoDisplay:
+            hasNoDisplay = YES;
+            break;
+        case RoomBubbleCellDataTagRoomCreationIntro:
+            hasNoDisplay = NO;
+            break;
+        case RoomBubbleCellDataTagPoll:
+            if (self.events.lastObject.isEditEvent) {
+                hasNoDisplay = YES;
+            }
+
+            hasNoDisplay = NO;
+            break;
+        case RoomBubbleCellDataTagLocation:
+            hasNoDisplay = NO;
+            break;
+        case RoomBubbleCellDataTagLiveLocation:
+            // If the summary does not exist don't show the cell
+            if (!self.beaconInfoSummary)
+            {
+                hasNoDisplay = YES;
+            }
+
+            hasNoDisplay = NO;
+            break;
+        case RoomBubbleCellDataTagVoiceBroadcast:
+            hasNoDisplay = YES;
+            break;
+        default:
+            hasNoDisplay = [super hasNoDisplay];
+            break;
     }
 
-    return [super hasNoDisplay];
+    return hasNoDisplay;
 }
 
 - (BOOL)hasThreadRoot
@@ -1050,6 +1059,9 @@ - (BOOL)addEvent:(MXEvent*)event andRoomState:(MXRoomState*)roomState
         case RoomBubbleCellDataTagLiveLocation:
             shouldAddEvent = NO;
             break;
+        case RoomBubbleCellDataTagVoiceBroadcast:
+            shouldAddEvent = NO;
+            break;
         default:
             break;
     }
@@ -1118,6 +1130,8 @@ - (BOOL)addEvent:(MXEvent*)event andRoomState:(MXRoomState*)roomState
                     {
                         shouldAddEvent = NO;
                     }
+                } else if ([event.type isEqualToString:VoiceBroadcastSettings.eventType]) {
+                    shouldAddEvent = NO;
                 }
                 break;
             }

Riot/Modules/Room/DataSources/RoomDataSource.swift

@@ -197,8 +197,6 @@ extension RoomDataSource {
 
         return editableTextMessage
     }
-
-
 }
 
 // MARK: - Private Helpers

Riot/Modules/Room/RoomViewController.m

@@ -2308,6 +2308,34 @@ - (void)setupActions {
             [self showCameraControllerAnimated:YES];
         }]];
     }
+    if (BuildSettings.voiceBroadcastEnabled && !self.isNewDirectChat)
+    {
+        [actionItems addObject:[[RoomActionItem alloc] initWithImage:AssetImages.actionLive.image andAction:^{
+            MXStrongifyAndReturnIfNil(self);
+            if ([self.inputToolbarView isKindOfClass:RoomInputToolbarView.class]) {
+                ((RoomInputToolbarView *) self.inputToolbarView).actionMenuOpened = NO;
+            }
+
+            MXSession* session = self.roomDataSource.mxSession;
+            [session getOrCreateVoiceBroadcastServiceFor:self.roomDataSource.room completion:^(VoiceBroadcastService *voiceBroadcastService) {
+                if (voiceBroadcastService) {
+                    if ([[voiceBroadcastService getState] isEqualToString:@"stopped"]) {
+                        [session.voiceBroadcastService startVoiceBroadcastWithSuccess:^(NSString * _Nullable success) {
+
+                        } failure:^(NSError * _Nonnull error) {
+
+                        }];
+                    } else {
+                        [session.voiceBroadcastService stopVoiceBroadcastWithSuccess:^(NSString * _Nullable success) {
+
+                        } failure:^(NSError * _Nonnull error) {
+
+                        }];
+                    }
+                }
+            }];            
+        }]];
+    }
     roomInputView.actionsBar.actionItems = actionItems;
 }
 

Riot/Modules/VoiceBroadcast/MXSession+VoiceBroadcast.swift

@@ -0,0 +1,31 @@
+// 
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+import MatrixSDK
+
+extension MXSession {
+
+    /// Convenient getter to retrieve VoiceBroadcastService associated to the session
+    @objc var voiceBroadcastService: VoiceBroadcastService? {
+        return VoiceBroadcastServiceProvider.shared.voiceBroadcastService
+    }
+
+    /// Initialize VoiceBroadcastService
+    @objc public func getOrCreateVoiceBroadcastService(for room: MXRoom, completion: @escaping (VoiceBroadcastService?) -> Void) {
+        VoiceBroadcastServiceProvider.shared.getOrCreateVoiceBroadcastService(for: room, completion: completion)
+    }
+}

Riot/Modules/VoiceBroadcast/VoiceBroadcastSDK/VoiceBroadcastEventContent.h

@@ -0,0 +1,37 @@
+// 
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#import <MatrixSDK/MatrixSDK.h>
+
+#import "MXJSONModel.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface VoiceBroadcastEventContent : MXJSONModel
+
+@property (nonatomic) NSString *state;
+
+@property (nonatomic) NSInteger chunkLength;
+
+@property (nonatomic, strong, nullable) NSString* eventId;
+
+- (instancetype)initWithState:(NSString *)state
+                  chunkLength:(NSInteger)chunkLength
+                      eventId:(NSString *)eventId;
+
+@end
+
+NS_ASSUME_NONNULL_END

Riot/Modules/VoiceBroadcast/VoiceBroadcastSDK/VoiceBroadcastEventContent.m

@@ -0,0 +1,79 @@
+// 
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#import "VoiceBroadcastEventContent.h"
+#import "GeneratedInterface-Swift.h"
+
+@implementation VoiceBroadcastEventContent
+
+- (instancetype)initWithState:(NSString *)state
+                  chunkLength:(NSInteger)chunkLength
+                      eventId:(NSString *)eventId
+{
+    if (self = [super init])
+    {
+        _state = state;
+        _chunkLength = chunkLength;
+        _eventId = eventId;
+    }
+
+    return self;
+}
+
++ (id)modelFromJSON:(NSDictionary *)JSONDictionary
+{
+    NSString *state;
+    MXJSONModelSetString(state, JSONDictionary[VoiceBroadcastSettings.voiceBroadcastContentKeyState]);
+
+    NSInteger chunkLength = BuildSettings.voiceBroadcastChunkLength;
+    if (JSONDictionary[VoiceBroadcastSettings.voiceBroadcastContentKeyChunkLength])
+    {
+        MXJSONModelSetInteger(chunkLength, JSONDictionary[VoiceBroadcastSettings.voiceBroadcastContentKeyChunkLength]);
+    }
+
+    NSString *eventId;
+    if (JSONDictionary[kMXEventRelationRelatesToKey]) {
+        MXEventContentRelatesTo *relatesTo;
+
+        MXJSONModelSetMXJSONModel(relatesTo, MXEventContentRelatesTo, JSONDictionary[kMXEventRelationRelatesToKey]);
+
+        if (relatesTo && [relatesTo.relationType isEqualToString:MXEventRelationTypeReference])
+        {
+            eventId = relatesTo.eventId;
+        }
+    }
+
+    return [[VoiceBroadcastEventContent alloc] initWithState:state chunkLength:chunkLength eventId:eventId];
+}
+
+- (NSDictionary *)JSONDictionary
+{
+    NSMutableDictionary *JSONDictionary = [NSMutableDictionary dictionary];
+
+    JSONDictionary[VoiceBroadcastSettings.voiceBroadcastContentKeyState] = self.state;
+
+    if (_eventId) {
+        MXEventContentRelatesTo *relatesTo = [[MXEventContentRelatesTo alloc] initWithRelationType:MXEventRelationTypeReference eventId:_eventId];
+
+        JSONDictionary[kMXEventRelationRelatesToKey] = relatesTo.JSONDictionary;
+    } else {
+        JSONDictionary[VoiceBroadcastSettings.voiceBroadcastContentKeyChunkLength] = @(self.chunkLength);
+    }
+
+    return JSONDictionary;
+}
+
+@end