RRHeadAvatar3DProductMetadata

Objective-C

@interface RRHeadAvatar3DProductMetadata : NSObject

Swift

class RRHeadAvatar3DProductMetadata : NSObject

This class represents the metadata you need to upload to the content service when capturing and uploading a HeadAvatar3D. To capture a HeadAvatar3D, please use the RRTrueDepthCaptureView class.

  • This property defines an arbitrary avatar name string.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull avatarName;

    Swift

    var avatarName: String { get set }
  • This property defines the avatar’s gender and will be used to select an appropriate body model for the avatar. Currently only RRGenderFemale and RRGenderMale are supported.

    See

    RRGender

    Declaration

    Objective-C

    @property (nonatomic) RRGender gender;

    Swift

    var gender: RRGender { get set }
  • This property defines the avatar’s full body height in centimeters.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger bodyHeight;

    Swift

    var bodyHeight: Int { get set }
  • This property defines the device platform. The device platform is readonly and will be automatically determined by the RRHeadAvatar3DProductMetadata class.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull devicePlatform;

    Swift

    var devicePlatform: String { get }
  • This property defines the device hardware name. The device name is readonly and will be automatically determined by the RRHeadAvatar3DProductMetadata class.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull deviceName;

    Swift

    var deviceName: String { get }
  • This property defines the device OS version string. The OS version is readonly and will be automatically determined by the RRHeadAvatar3DProductMetadata class.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull osVersion;

    Swift

    var osVersion: String { get }
  • This method returns the JSON string that represents the state of the RRHeadAvatar3DProductMetadata instance. This JSON string should be used as the product metadata when uploading a HeadAvatar3D product.

    Declaration

    Objective-C

    - (nonnull NSString *)getJsonString;

    Swift

    func getJsonString() -> String

    Return Value

    A JSON string representing the current state of this instance.

  • This method deserializes an RRHeadAvatar3DProductMetadata instance from a given JSON string.

    Declaration

    Objective-C

    + (RRHeadAvatar3DProductMetadata *_Nullable)fromJsonString:
        (nonnull NSString *)jsonString;

    Swift

    class func fromJsonString(_ jsonString: String) -> RRHeadAvatar3DProductMetadata?

    Parameters

    jsonString

    A JSON string representing an RRHeadAvatar3DProductMetadata instance.

    Return Value

    The deserialized RRHeadAvatar3DProductMetadata instance on success, nil otherwise.