## On this page

  

 

 # ensightservice::SubscribeImageOptions Struct Reference

 Last update: 16.07.2025 

## <a id="pub-types" name="pub-types"></a>Public Types

enum [ChannelType](structensightservice_1_1_subscribe_image_options.xhtml#afa81ebc38c1801fe0f3ae7262798d340) { [GRPC](structensightservice_1_1_subscribe_image_options.xhtml#afa81ebc38c1801fe0f3ae7262798d340a74944b7a7e1ad133402aa6e048dfe4c6) = 0 , [SHARED\_MEM](structensightservice_1_1_subscribe_image_options.xhtml#afa81ebc38c1801fe0f3ae7262798d340ad27444fa0b847e6156e29260e99b32c8) = 1 } Image channel type The image subscription can be via gRPC protocol or via shared memory transport. [More...](structensightservice_1_1_subscribe_image_options.xhtml#afa81ebc38c1801fe0f3ae7262798d340)  
 ## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

<a id="a3c11161da5e7dd00b8c3930651329d9b"></a>string [prefix](structensightservice_1_1_subscribe_image_options.xhtml#a3c11161da5e7dd00b8c3930651329d9b) = 1 A unique prefix string (perhaps a GUID) used to identify this stream (used by [Unsubscribe()](group___en_sight_service.xhtml#ga9161e678fe3d7608820907269d55bf8c))   
 <a id="a5542ba033c19b9319e825ae01861617b"></a>[ChannelType](structensightservice_1_1_subscribe_image_options.xhtml#afa81ebc38c1801fe0f3ae7262798d340) [type](structensightservice_1_1_subscribe_image_options.xhtml#a5542ba033c19b9319e825ae01861617b) = 2 Select GRPC or SHARED\_MEM transport.   
 <a id="a5e15879112029f4c126e615d42ef2fdd"></a>bool [flip\_vertical](structensightservice_1_1_subscribe_image_options.xhtml#a5e15879112029f4c126e615d42ef2fdd) = 3 If true, flip the image over the X axis before sending the image.   
 <a id="a04eab75e486e8586ce9e434596190fa0"></a>bool [chunk](structensightservice_1_1_subscribe_image_options.xhtml#a04eab75e486e8586ce9e434596190fa0) = 4 Set to send images in 1MB chunks to speed up large (&gt;1MB) image transfers (see [ImageStreamRequest](structensightservice_1_1_image_stream_request.xhtml "Request the start of an image stream.") and [ImageReply](structensightservice_1_1_image_reply.xhtml "An image frame message."))   
 map&lt; string, string &gt; [options](structensightservice_1_1_subscribe_image_options.xhtml#a9915819de6a6c41c9710a2d811fb3cb6) = 5 various type specific options [More...](structensightservice_1_1_subscribe_image_options.xhtml#a9915819de6a6c41c9710a2d811fb3cb6)  
 <a id="details" name="details"></a>## Detailed Description

The image subscription options

Definition at line [177](ensight_8proto_source.xhtml#l00177) of file [ensight.proto](ensight_8proto_source.xhtml).



## Member Enumeration Documentation

<a id="afa81ebc38c1801fe0f3ae7262798d340"></a>## [◆ ](#afa81ebc38c1801fe0f3ae7262798d340)ChannelType

 enum [ensightservice::SubscribeImageOptions::ChannelType](structensightservice_1_1_subscribe_image_options.xhtml#afa81ebc38c1801fe0f3ae7262798d340)

Image channel type The image subscription can be via gRPC protocol or via shared memory transport.

Enumerator<a id="afa81ebc38c1801fe0f3ae7262798d340a74944b7a7e1ad133402aa6e048dfe4c6"></a>GRPC EnSight should use gRPC [PublishImage()](group___en_sight_subscription.xhtml#ga052334cb4098295f08b649151eb24320) calls to send images back to the client.

<a id="afa81ebc38c1801fe0f3ae7262798d340ad27444fa0b847e6156e29260e99b32c8"></a>SHARED\_MEM EnSight should use a [SharedMemoryImageStream](shared__memory__image__client_8h.xhtml#af5b8eb2ae90823f10e9a17698ea80749) to send images back to the client.

Definition at line [181](ensight_8proto_source.xhtml#l00181) of file [ensight.proto](ensight_8proto_source.xhtml).





## Member Data Documentation

<a id="a9915819de6a6c41c9710a2d811fb3cb6"></a>## [◆ ](#a9915819de6a6c41c9710a2d811fb3cb6)options

 map&lt;string, string&gt; ensightservice::SubscribeImageOptions::options = 5

various type specific options

For type=GRPC, 'uri' map key contains the URI for the server launched by the client (required). 'num\_retries' map key is the number of times EnSight should attempt to connect before failing the operation. 'shared\_secret' map key is the shared secret that the client gRPC server is expecting to see to authenticate a connection.

For type=SHARED\_MEM, 'filename' map key contains the name of local file to be used as the memory mapped shared memory block (required).

Definition at line [198](ensight_8proto_source.xhtml#l00198) of file [ensight.proto](ensight_8proto_source.xhtml).





---

The documentation for this struct was generated from the following file:- D:/ANSYSDev/NoBackup/branches/EnSight-Second-Coming/ensight/client/rpc\_interface/[ensight.proto](ensight_8proto_source.xhtml)