SCALAR
String
The String
scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
link GraphQL Schema definition
- scalar String
link Require by
- AccessKeyA security secret to control access to graphQL objects.
- AccessKeyInputnull
- BroadcastA streaming event.
- BroadcastCreateInputA broadcast definition.
- BroadcastDisplayThe configuration of the encoder HDMI output.
- BroadcastDisplayInfoA display definition.
- BroadcastDisplayInputA display definition.
- BroadcastEncoderA reference to an encoder.
- BroadcastEncoderInputAn encoder reference definition.
- BroadcastGoLiveEventA collection of metrics related to a broadcast go live event.
- BroadcastGroupA collection of broadcasts.
- BroadcastGroupCreateInputA broadcast group definition.
- BroadcastInputThe input to the broadcast.
- BroadcastInputInfoThe input to the broadcast.
- BroadcastInputInputThe input to the broadcast.
- BroadcastInputSlateItemA slate item definition.
- BroadcastInputSlateItemInputA slate item definition.
- BroadcastInputVideoOverlayInputA graphic overlay definition.
- BroadcastMediaCasterInputA MediaCaster intput definition.
- BroadcastOutputThe broadcast output.
- BroadcastOutputInputA broadcast output definition.
- BroadcastProviderStreamTargetA stream target provided by a third party.
- BroadcastProviderStreamTargetAbreviatedAbbreviated information for a stream target provided by a third party.
- BroadcastRecordingA recording configuration.
- BroadcastRecordingInfoA recording definition.
- BroadcastRecordingInputA recording definition.
- BroadcastStreamTargetA stream target configuration
- BroadcastStreamTargetInfonull
- BroadcastStreamTargetInputA stream target definition.
- CompanyA collection of namespaces associated with a given company.
- CompanyCreateInputA company definition.
- EncoderThe hardware encoder.”
- EncoderActivateInputEncoder activation information.
- EncoderAssetInputAn encoder asset information.
- EncoderCommandMutationResponsenull
- EncoderCommandRecievedA subscription event that is triggered when an encoder command has been sent.
- EncoderCommandResponseRecievednull
- EncoderCommandStatusThe status of a command sent to an encoder.
- EncoderCreateInputAn encoder definition.
- EncoderGroupA collection of encoders.
- EncoderGroupCreateInputA group encoder definition.
- EncoderStatusThe encoder status and software version.
- EncoderStatusInputA group status definition.
- EncodingConfigurationThe encoding configuration.
- EncodingConfigurationAudioThe audio encoding configuration.
- EncodingConfigurationAudioInfoA broadcast audio encoding configuration definition. No default values. Only fields for which you specify values are set.
- EncodingConfigurationAudioInputA broadcast audio encoding configuration definition.
- EncodingConfigurationInputA broadcast encoding configuration definition.
- EncodingConfigurationVideoThe video encoding configuration.
- EncodingConfigurationVideoInfoA broadcast video encoding configuration definition. No default values. Only fields for which you specify values are set.
- EncodingConfigurationVideoInputA broadcast video encoding configuration definition.
- ExtraPropertyBroadcastA user-defined name-value pair.
- ExtraPropertyBroadcastGroupA user-defined name-value pair.
- ExtraPropertyCompanyA user-defined name-value pair.
- ExtraPropertyEncoderA user-defined name-value pair.
- ExtraPropertyEncoderGroupA user-defined name-value pair.
- ExtraPropertyEncodingConfigurationA user-defined name-value pair.
- ExtraPropertyInputA user-defined name-value pair definition.
- ExtraPropertyNamespaceA user-defined name-value pair.
- ExtraPropertyTranscodingConfigurationA user-defined name-value pair.
- IExtraPropertyA user-defined name-value pair.
- LogA log event.
- LogFileThe definition of a log file, internal use only.
- LogFileProcessInputThe definition of a log processing event.
- Mutationnull
- MutationResponseThe result of a mutation operation.
- NamespaceA collection of encoders, broadcasts, encoderGroups, and broadcastGroups.
- NamespaceCreateInputA namespace definition.
- NamespaceUserA namespace user.
- NearRealTimeDataThe most recent instance of near real-time metrics related to an encoder and its associated broadcast. Data is collected every 10 seconds while a broadcast is active.
- NearRealTimeDataGraphQLSubscriptionClientThe GraphQL subscription network status.
- NearRealTimeDataNetworkInfoThe network interface statistics.
- NearRealTimeDataOutputA collection of information on each broadcast output.
- NearRealTimeDataPublishSessionThe broadcast session information.
- NearRealTimeDataScheduleSlateItemNearRealTimeDataScheduleSlateItem
- NearRealTimeDataSSNetworkInfoThe kernel-level network performance information for the TCP connection.
- NearRealTimeDataStreamTargetThe stream target information.
- ProviderKeyA security secret, in the form of a provider key, that controls access to external service providers.
- ProviderKeyInputA provider key definition.
- Querynull
- RecordingAssetA recording asset of a broadcast.
- RecordingAssetInputA recoding asset definition.
- Subscriptionnull
- TranscoderParameterAudioAn encoding parameter.
- TranscoderParameterAudioInputAn encoding parameter definition.
- TranscoderParameterDecodingVideoA video decoding parameter.
- TranscoderParameterDecodingVideoInputA video decoding parameter.
- TranscoderParameterVideoAn encoding parameter.
- TranscoderParameterVideoDecodeInputAn encoding parameter definition.
- TranscoderParameterVideoInputAn encoding parameter definition.
- TranscodingConfigurationDecodingVideoThe decoding configuration.
- TranscodingConfigurationDecodingVideoInfoA decoding configuration definition.
- TranscodingConfigurationDecodingVideoInputA decoding configuration definition.
- TranscodingConfigurationScalingThe video scaling configuration.
- TranscodingConfigurationScalingInfoA scaling configuration definition.
- TranscodingConfigurationScalingInputA scaling configuration definition.
- UserA user.
- __DirectiveA Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
- __EnumValueOne possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
- __FieldObject and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
- __InputValueArguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
- __TypeThe fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.