{"id":4365,"date":"2021-11-18T14:28:38","date_gmt":"2021-11-18T06:28:38","guid":{"rendered":"https:\/\/www.enablex.io\/developer\/?page_id=4365"},"modified":"2025-04-11T20:34:32","modified_gmt":"2025-04-11T12:34:32","slug":"annotation","status":"publish","type":"page","link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/video-api\/client-api\/ios-toolkit\/annotation\/","title":{"rendered":"Annotation: iOS SDK &#8211; Video API"},"content":{"rendered":"\n<p><strong>Availability<\/strong>: <em>iOS SDK v1.5.6+<\/em><\/p>\n\n\n\n<p>The Annotation feature allows you to annotate on a Remote Stream. To support Annotations, you need to enable Canvas Streaming during <a href=\"\/developer\/video-api\/server-api\/rooms-route\/#create-room\" target=\"_blank\" rel=\"noreferrer noopener\">Room Creation<\/a> by setting: { canvas: true; }} in the JSON payload. To implement Annotation, you need to add Annotation Toolbar before you can start Annotations.<\/p>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4>Table of Contents<\/h4>\n\n\n\n<ul><li><a href=\"#annotation-toolbar\">Annotation Toolbar<\/a><\/li><li><a href=\"#start-stop-annotation\">Start \/ Stop Annotation<\/a><\/li><\/ul>\n\n\n\n<a name=\"annotation-toolbar\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Add Annotation Toolbar<\/h3>\n\n\n\n<p>Initiate Annotation Toolbar using the following code in XML:<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">EnxToolBar *toolBar = [[EnxToolBar alloc] initWithFrame:CGRectMake(X, Y, width, height)];<\/pre>\n\n\n\n<a name=\"start-stop-annotation\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Start Annotation<\/h3>\n\n\n\n<p>The <code>EnxRoom.startAnnotation()<\/code> is used to start Annotation on a given Stream object. <\/p>\n\n\n\n<p><strong>Class<\/strong>:&nbsp;<code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method:<\/strong><\/p>\n\n\n\n<ul><li><code>-(void)startAnnotation:(EnxStream *_Nonnull)stream<\/code>&nbsp;<\/li><\/ul>\n\n\n\n<p><strong>Parameter:<\/strong>&nbsp;<\/p>\n\n\n\n<p><code>EnxStream<\/code> &#8211; Stream Object to be annotated.<\/p>\n\n\n\n<p><strong>Delegate Methods<\/strong>:<\/p>\n\n\n\n<ul><li><code>-room:didStartAnnotationACK:(NSArray *_Nullable)Data<\/code>&nbsp;\u2013 Acknowledgment to the Annotator when Annotation starts.<\/li><li><code>-room:didAnnotationStarted:(NSArray *_Nullable)Data<\/code>&nbsp;\u2013 Notification to everyone in the Room when Annotation starts.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">\/\/ Start Annotation\n-(void)startAnnotation:(EnxStream*_Nonnull)stream;\n\n\/\/ Stop Annotation\n-(void)stopAnnotation;  \n\n\/\/ Notification to all - Annotation started\n-(void)room: (EnxRoom *_Nullable) room didAnnotationStarted: (NSArray *_Nullable) Data; \n\n\/\/ Acknowlegement to Annotator - Annotation started\n-(void)room: (EnxRoom *_Nullable) room didStartAnnotationACK: (NSArray *_Nullable) Data; \n\n\/\/ Notification to all - Annotation stopped\n-(void)room: (EnxRoom *_Nullable) room didAnnotationStopped: (NSArray *_Nullable) Data; \n\n\/\/ Acknowlegement to Annotator - Annotation stopped\n-(void)room: (EnxRoom *_Nullable) room didStoppedAnnotationACK: (NSArray *_Nullable) Data; <\/pre>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Stop Annotation<\/h3>\n\n\n\n<p>The <code>EnxRoom.stopAnnotation()<\/code> method is used to stop Annotations.<\/p>\n\n\n\n<p><strong>Method:<\/strong><\/p>\n\n\n\n<p><code>-(void)stopAnnotation<\/code>&nbsp;<\/p>\n\n\n\n<p><strong>Delegate Methods:<\/strong><\/p>\n\n\n\n<ul><li><code>-room:didStoppedAnnotationACK:(NSArray *_Nullable)Data<\/code>&nbsp;\u2013 Acknowledgment to the Annotator when Annotation stops.<\/li><li><code>-room:didAnnotationStopped:(NSArray *_Nullable)Data<\/code>&nbsp;\u2013 Notification to everyone in the Room when Annotation stops.<\/li><\/ul>\n\n\n\n<p><strong><strong>Error Codes \/ Exceptions<\/strong>:<\/strong>&nbsp;<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Code<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>5093<\/td><td>Annotation Access denied.<\/td><\/tr><tr><td>5104<\/td><td>Repeated <code>startAnnotation()<\/code> call made while Annotations already active in the Room.<\/td><\/tr><tr><td>5106<\/td><td>Repeated <code>startAnnotation()<\/code> call made while a previous request is in process.<\/td><\/tr><tr><td>5108<\/td><td>Invalid Stream passed to <code>startAnnotation()<\/code>.<\/td><\/tr><tr><td>5109<\/td><td>Failed to publish Annotation Stream.<\/td><\/tr><tr><td>5112<\/td><td>Annotation support available in Landscape Mode only.<\/td><\/tr><tr><td>5094<\/td><td>Repeated <code>stopAnnotation()<\/code> call made while a previous request is in process.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<hr class=\"wp-block-separator is-style-wide\"\/>\n\n\n\n<div class=\"wp-block-columns\">\n<div class=\"wp-block-column\">\n<p>\u2190 <a href=\"..\/canvas-streaming\/\">Canvas Streaming<\/a><\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column\">\n<p class=\"has-text-align-center\"><a href=\"..\/\">Index<\/a><\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column\">\n<p class=\"has-text-align-right\"><a href=\"..\/recording\/\">Record Session<\/a> \u2192<a href=\"\/developer\/how-to-use\/\"><\/a><\/p>\n<\/div>\n<\/div>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Availability: iOS SDK v1.5.6+ The Annotation feature allows you to annotate on a Remote Stream. To support Annotations, you need to enable Canvas Streaming during Room Creation by setting: { canvas: true; }} in the JSON payload. To implement Annotation, you need to add Annotation Toolbar before you can start Annotations. Table of Contents Annotation Toolbar Start \/ Stop Annotation Add Annotation Toolbar Initiate Annotation Toolbar using the following code&hellip; <\/p>\n","protected":false},"author":1,"featured_media":0,"parent":3732,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"ub_ctt_via":""},"featured_image_src":null,"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"featured":false,"featured-large":false},"uagb_author_info":{"display_name":"vcxdevwpadmin","author_link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/author\/vcxdevwpadmin\/"},"uagb_comment_info":0,"uagb_excerpt":"Availability: iOS SDK v1.5.6+ The Annotation feature allows you to annotate on a Remote Stream. To support Annotations, you need to enable Canvas Streaming during Room Creation by setting: { canvas: true; }} in the JSON payload. To implement Annotation, you need to add Annotation Toolbar before you can start Annotations. Table of Contents Annotation&hellip;","_links":{"self":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4365"}],"collection":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/comments?post=4365"}],"version-history":[{"count":0,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4365\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/3732"}],"wp:attachment":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/media?parent=4365"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}