OBJECT
Mutation
link GraphQL Schema definition
- type Mutation {
- Boolean :
- # Creates and returns a new company.
- #
- # Arguments
- # input: The company definition.
- CompanyCreateInput!): Company ( :
- # Renames a company and returns the updated company.
- #
- # Arguments
- # companyId: The company ID.
- # name: The updated company name.
- ID!, : String!): Company ( :
- # Deletes a company.
- #
- # Arguments
- # companyId: The company ID.
- ID!): DeleteResult ( :
- # Reissues a company's access key.
- #
- # Arguments
- # companyId: The company ID.
- ID!): AccessKey ( :
- # Sets a property on a company.
- #
- # Arguments
- # companyId: The company ID.
- # input: The property definition.
- (
- ID!, :
- ExtraPropertyInput! :
- ): Company
- # Deletes a property from a company.
- #
- # Arguments
- # companyId: The company ID.
- # name: The name of the property to be deleted.
- (
- ID!, :
- String! :
- ): Company
- # Sets encoder asset information.
- #
- # Arguments
- # companyId: The company ID.
- # input: The encoder assset information.
- (
- ID!, :
- EncoderAssetInput! :
- ): Company
- # Creates and returns a new access key.
- #
- # Arguments
- # identityId: The ID of the identity to which the access key
- # authenticates.
- # name: Deprecated. The name of the access key.
- # input: The access key definition.
- ID!, : String, : AccessKeyInput): AccessKey ( :
- # Deletes an access key.
- #
- # Arguments
- # id: The ID of the access key.
- String!): DeleteResult ( :
- # Creates and returns a new provider key.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # input: The provider key definition.
- ID!, : ProviderKeyInput): ProviderKey ( :
- # Deletes a provider key.
- #
- # Arguments
- # id: The provider key ID.
- ID!): DeleteResult ( :
- # Creates and returns the broadcast.
- #
- # Arguments
- # namespaceId: The parent namespace ID.
- # input: The broadcast definition.
- ID!, : BroadcastCreateInput!): Broadcast ( :
- # Renames a broadcast and returns the updated broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # name: The updated broadcast name.
- ID!, : String!): EncoderGroup ( :
- # Deletes a broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- ID!): DeleteResult ( :
- # Creates and returns a new broadcast group.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # input: The broadcast group definition.
- (
- ID!, :
- BroadcastGroupCreateInput! :
- ): BroadcastGroup
- # Renames a broadcast group and returns the updated broadcast group.
- #
- # Arguments
- # broadcastGroupId: The broadcast group ID.
- # name: The updated broadcast group name.
- ID!, : String!): BroadcastGroup ( :
- # Deletes a broadcast group.
- #
- # Arguments
- # broadcastGroupId: The broadcast group ID.
- ID!): DeleteResult ( :
- # Adds a broadcast to a broadcast group and returns the updated broadcast group.
- #
- # Arguments
- # broadcastGroupId: The broadcast group ID.
- # broadcastId: The broadcast ID.
- (
- ID!, :
- ID! :
- ): BroadcastGroup
- # Removes a broadcast from a broadcast group and returns the updated broadcast
- # group.
- #
- # Arguments
- # broadcastGroupId: The broadcast group ID.
- # broadcastId: The broadcast ID.
- (
- ID!, :
- ID! :
- ): BroadcastGroup
- # Sets the status of a broadcast and returns the updated broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # status: The broadcast status.
- (
- ID!, :
- ENUM_BROADCASTSTATUS! :
- ): Broadcast
- # Adds a broadcast input to an exisiting broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # input: The broadcast input type definition.
- (
- ID, :
- BroadcastInputInput! :
- ): Broadcast
- # Sets the input type for a broadcast and returns the updated broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # broadcastInputId: The broadcast input ID.
- # input: The broadcast input type definition.
- (
- ID, :
- ID, :
- BroadcastInputInfo! :
- ): Broadcast
- # Sets the input type for a broadcast and returns the updated broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # broadcastInputId: The broadcast input ID.
- # input: The broadcast input type definition.
- (
- ID, :
- ID, :
- BroadcastInputTypeInput! :
- ): Broadcast
- # Sets the video input for a broadcast and returns the updated broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # broadcastInputId: The broadcast input ID.
- # input: The video input definition.
- (
- ID, :
- ID, :
- BroadcastInputVideoInputInput! :
- ): Broadcast
- # Sets the video capture maximum frame size for a broadcast and returns the
- # updated broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # broadcastInputId: The broadcast input ID.
- # input: The video capture maximum frame size definition.
- (
- ID, :
- ID, :
- BroadcastInputVideoMaxFrameSizeInput! :
- ): Broadcast
- # Sets the video capture maximum frame rate for a broadcast and returns the
- # updated broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # broadcastInputId: The broadcast input ID.
- # input: The video capture maximum frame rate definition.
- (
- ID, :
- ID, :
- BroadcastInputVideoMaxFrameRateInput! :
- ): Broadcast
- # Sets the video capture keyframe interval for a broadcast and returns the updated
- # broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # broadcastInputId: The broadcast input ID.
- # input: The video capture keyframe interval definition.
- (
- ID, :
- ID, :
- BroadcastInputVideoKeyFrameIntervalMillisecondsInput! :
- ): Broadcast
- # Sets the video capture aspect ration for a broadcast and returns the updated
- # broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # broadcastInputId: The broadcast input ID.
- # input: The video capture aspect ratio definition.
- (
- ID, :
- ID, :
- BroadcastInputVideoAspectRatioInput! :
- ): Broadcast
- # Sets a graphic overlay for a broadcast and returns the updated broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # broadcastInputId: The broadcast input ID.
- # input: The graphic overlay definition.
- (
- ID, :
- ID, :
- BroadcastInputVideoOverlayInput! :
- ): Broadcast
- # Sets the audio channel map for a broadcast and returns the updated broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # broadcastInputId: The broadcast input ID.
- # input: The audio channel map definition.
- (
- ID, :
- ID, :
- BroadcastInputAudioChannelsInput :
- ): Broadcast
- # Sets the audio level for a broadcast and returns the updated broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # broadcastInputId: The broadcast input ID.
- # input: The audio level definition.
- (
- ID, :
- ID, :
- BroadcastInputAudioLevelInput! :
- ): Broadcast
- # Sets the MediaCaster input for a broadcast and returns the updated broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # broadcastInputId: The broadcast input ID.
- # input: The MediaCaster intput definition.
- (
- ID, :
- ID, :
- BroadcastMediaCasterInput! :
- ): Broadcast
- # Creates and returns a new broadcast output.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # input: The broadcast output definition.
- (
- ID!, :
- BroadcastOutputInput! :
- ): BroadcastOutput
- # Sets the stream name of a broadcast output and returns the updated broadcast
- # output.
- #
- # Arguments
- # broadcastOutputId: The broadcast output ID.
- # streamName: The stream name.
- (
- ID!, :
- String! :
- ): BroadcastOutput
- # Sets an identifying tag for a broadcast output object and returns the updated
- # broadcast output.
- #
- # Arguments
- # broadcastOutputId: The broadcast output ID.
- # tag: The identifying tag.
- ID!, : String!): BroadcastOutput ( :
- # Deletes a broadcast output.
- #
- # Arguments
- # broadcastOutputId: The broadcast output ID.
- ID!): DeleteResult ( :
- # Creates and returns a new broadcast display.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # input: [Not documented]
- (
- ID!, :
- BroadcastDisplayInput! :
- ): BroadcastDisplay
- # Sets the broadcast display information and returns the updated broadcast
- # display.
- #
- # Arguments
- # broadcastDisplayId: The broadcast display ID.
- # input: The broadcast display definition.
- (
- ID!, :
- BroadcastDisplayInfo! :
- ): BroadcastDisplay
- # Deletes a broadcast display.
- #
- # Arguments
- # broadcastDisplayId: The broadcast display ID.
- ID!): DeleteResult ( :
- # Sets the post-processing configuration for a broadcast and returns the updated
- # broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # input: The post-processing configuration definition.
- (
- ID!, :
- TranscodingConfigurationPostProcessingInfo! :
- ): Broadcast
- # Sets the decoding configuration for a broadcast and returns the updated
- # broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # input: The decoding configuration definition.
- (
- ID!, :
- TranscodingConfigurationDecodingVideoInfo! :
- ): Broadcast
- # Sets the scaling configuration for a broadcast and returns the updated
- # broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # input: The scaling configuration definition.
- (
- ID!, :
- TranscodingConfigurationScalingInfo! :
- ): Broadcast
- # Sets a property on a transcoding configuration.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # input: The property definition.
- (
- ID!, :
- ExtraPropertyInput! :
- ): Broadcast
- # Deletes a property from a transcoding configuration.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # name: The name of the property to be deleted.
- (
- ID!, :
- String! :
- ): Broadcast
- # Sets a decoding parameter on a transcoding configuration.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # input: The property definition.
- (
- ID!, :
- TranscoderParameterVideoDecodeInput! :
- ): Broadcast
- # Deletes a decoding parameter from a transcoding configuration.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # name: The name of the property to be deleted.
- (
- ID!, :
- String! :
- ): Broadcast
- # Creates and returns a new broadcast encoder.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # input: The broadcast encoder definition.
- (
- ID!, :
- BroadcastEncoderInput! :
- ): Broadcast
- # Deletes a broadcast encoder.
- #
- # Arguments
- # broadcastEncoderId: The broadcast encoder ID.
- ID!): DeleteResult ( :
- # Sets the Facebook Speed Test results for a broadcast encoder
- #
- # Arguments
- # broadcastEncoderId: The broadcast encoder ID.
- # input: [Not documented]
- (
- ID!, :
- BroadcastEncoderFacebookSpeedTestInput! :
- ): BroadcastEncoder
- # Deletes a broadcast encoder by encoder ID.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # encoderId: The encoder id.
- (
- ID!, :
- ID! :
- ): DeleteResult
- # Activates the encoders associated with a broadcast and returns the broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- ID!): Broadcast ( :
- # Deactivates the encoders associated with a broadcast and returns the broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- ID!): Broadcast ( :
- # Renames encoding configuration and returns the updated encoding configuration.
- #
- # Arguments
- # encodingConfigurationId: The encoding configuration ID.
- # name: The updated encoding configuration name.
- (
- ID!, :
- String! :
- ): EncodingConfiguration
- # Sets the video encoding configuration of an encoding configuration and returns
- # the updated video encoding configuration.
- #
- # Arguments
- # encodingConfigurationVideoId: The video encoding configuration
- # ID.
- # input: The video encoding configuration definition.
- (
- ID!, :
- EncodingConfigurationVideoInfo! :
- ): EncodingConfigurationVideo
- # Sets the audio encoding configuration of an encoding configuration and returns
- # the updated audio encoding configuration.
- #
- # Arguments
- # encodingConfigurationAudioId: The audio encoding configuration
- # ID.
- # input: The audio encoding configuration definition.
- (
- ID!, :
- EncodingConfigurationAudioInfo! :
- ): EncodingConfigurationAudio
- # Sets a video encoding configuration parameter on a video encoding configuration.
- #
- # Arguments
- # encodingConfigurationVideoId: The video encoding configuration
- # ID.
- # input: The parameter definition.
- (
- ID!, :
- TranscoderParameterVideoInput! :
- ): EncodingConfigurationVideo
- # Deletes a video encoding configuration parameter from a video encoding
- # configuration.
- #
- # Arguments
- # encodingConfigurationVideoId: [Not documented]
- # name: The name of the parameter to be deleted.
- (
- ID!, :
- String! :
- ): EncodingConfigurationVideo
- # Sets an audio encoding configuration parameter on an audio encoding
- # configuration.
- #
- # Arguments
- # encodingConfigurationAudioId: The audio encoding configuration
- # ID.
- # input: The parameter definition.
- (
- ID!, :
- TranscoderParameterAudioInput! :
- ): EncodingConfigurationAudio
- # Deletes an audio encoding configuration parameter from a video audio
- # configuration.
- #
- # Arguments
- # encodingConfigurationAudioId: The audio encoding configuration
- # ID.
- # name: The name of the parameter to be deleted.
- (
- ID!, :
- String! :
- ): EncodingConfigurationAudio
- # Creates and returns a new stream target.
- #
- # Arguments
- # broadcastOutputId: The broadcast output ID.
- # input: The stream target definition.
- (
- ID!, :
- BroadcastStreamTargetInput! :
- ): BroadcastStreamTarget
- # Sets a stream target and returns the udpated stream target.
- #
- # Arguments
- # broadcastStreamTargetId: The stream target ID.
- # input: The stream target definition.
- (
- ID!, :
- BroadcastStreamTargetInfo! :
- ): BroadcastStreamTarget
- # Deletes a stream target.
- #
- # Arguments
- # broadcastStreamTargetId: The stream target ID.
- (
- ID! :
- ): DeleteResult
- # Creates and returns a new recording configuration.
- #
- # Arguments
- # broadcastOutputId: The broadcast output ID.
- # input: The recording configuration definition.
- (
- ID!, :
- BroadcastRecordingInput! :
- ): BroadcastRecording
- # Sets a recording configuration and returns the udpated recording configuration.
- #
- # Arguments
- # broadcastRecordingId: The recording configuration ID.
- # input: The recording configuration definition.
- (
- ID!, :
- BroadcastRecordingInfo! :
- ): BroadcastRecording
- # Deletes a recording configuration.
- #
- # Arguments
- # broadcastRecordingId: The recording configuration ID.
- ID!): DeleteResult ( :
- # Sets a property on a broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # input: The property definition.
- (
- ID!, :
- ExtraPropertyInput! :
- ): Broadcast
- # Deletes a property from a broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # name: The name of the property to be deleted.
- (
- ID!, :
- String! :
- ): Broadcast
- # Sets a property on a broadcast group.
- #
- # Arguments
- # broadcastGroupId: The broadcast group ID.
- # input: The property definition.
- (
- ID!, :
- ExtraPropertyInput! :
- ): BroadcastGroup
- # Deletes a property from a broadcast group.
- #
- # Arguments
- # broadcastGroupId: The broadcast group ID.
- # name: The name of the property to be deleted.
- (
- ID!, :
- String! :
- ): BroadcastGroup
- # Sets a property to an encoding configuration.
- #
- # Arguments
- # encodingConfigurationId: The encoding configuration ID.
- # input: The property definition.
- (
- ID!, :
- ExtraPropertyInput! :
- ): EncodingConfiguration
- # Deletes a property from an encoding configuration.
- #
- # Arguments
- # encodingConfigurationId: The encoding configuration ID.
- # name: The name of the property to be deleted.
- (
- ID!, :
- String! :
- ): EncodingConfiguration
- # Creates and returns a new encoder.
- #
- # Arguments
- # namespaceId: The ID of the parent namespace to which the
- # encoder belongs.
- # input: The encoder definition.
- ID!, : EncoderCreateInput!): Encoder ( :
- # Renames an encoder and returns the updated encoder.
- #
- # Arguments
- # encoderId: The encoder ID.
- # name: The updated encoder name.
- ID!, : String!): Encoder ( :
- # Deletes an encoder.
- #
- # Arguments
- # encoderId: The encoder ID.
- ID!): DeleteResult ( :
- # Re-issues the access key for an encoder.
- #
- # Arguments
- # encoderId: The encoder ID.
- ID!): AccessKey ( :
- # Creates and returns a new encoder group.
- #
- # Arguments
- # namespaceId: The ID of the parent namespace to which the
- # encoder group belongs.
- # input: The encoder group definition.
- (
- ID!, :
- EncoderGroupCreateInput! :
- ): EncoderGroup
- # Renames an encoder group and returns the updated encoder group.
- #
- # Arguments
- # encoderGroupId: The encoder group ID.
- # name: The updated encoder group name.
- ID!, : String!): EncoderGroup ( :
- # Deletes an encoder group.
- #
- # Arguments
- # encoderGroupId: The encoder group ID.
- ID!): DeleteResult ( :
- # Adds an encoder to an encoder group and returns the updated encoder group.
- #
- # Arguments
- # encoderGroupId: The encoder group ID.
- # encoderId: The encoder ID.
- (
- ID!, :
- ID! :
- ): EncoderGroup
- # Removes an encoder from an encoder group and returns the updated encoder group.
- #
- # Arguments
- # encoderGroupId: The encoder group ID.
- # encoderId: The encoder ID.
- (
- ID!, :
- ID! :
- ): EncoderGroup
- # Sets status as well as the audio and video capture session information for an
- # encoder and returns the status.
- #
- # Arguments
- # encoderId: The encoder ID.
- # input: The status definition.
- (
- ID!, :
- EncoderStatusAllInput! :
- ): UpdateResult
- # Sets the hardware information of an encoder and returns the encoder object.
- #
- # Arguments
- # encoderId: The encoder ID.
- # input: The hardware information.
- (
- ID!, :
- EncoderHardwareInfoInput! :
- ): Encoder
- # Sets the status of an encoder and returns the encoder object.
- #
- # Arguments
- # encoderId: The encoder ID.
- # input: The status definition.
- ID!, : EncoderStatusInput!): Encoder ( :
- # Sets the audio and video capture session information for an encoder.
- #
- # Arguments
- # encoderId: The encoder ID.
- # input: The audio and video capture session information.
- (
- ID!, :
- EncoderCaptureSessionInfoInput! :
- ): Encoder
- # Sets a property on an encoder.
- #
- # Arguments
- # encoderId: The encoder ID.
- # input: The property definition.
- (
- ID!, :
- ExtraPropertyInput! :
- ): Encoder
- # Deletes a property from an encoder.
- #
- # Arguments
- # encoderId: The encoder ID.
- # name: The name of the property to be deleted.
- (
- ID!, :
- String! :
- ): Encoder
- # Sets a property on an encoder group.
- #
- # Arguments
- # encoderGroupId: The encoder group ID.
- # input: The property definition.
- (
- ID!, :
- ExtraPropertyInput! :
- ): EncoderGroup
- # Deletes a property from an encoder group.
- #
- # Arguments
- # encoderGroupId: The encoder group ID.
- # name: The name of the property to be deleted.
- (
- ID!, :
- String! :
- ): EncoderGroup
- # Uses an EncoderActivateInput to determine if the encoder can be added to a
- # namespace.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # input: Activate Encoder Input.
- (
- ID!, :
- EncoderActivateInput! :
- ): EncoderCanBeAddedToNamespace
- # Activates an encoder and returns the updated encoder.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # input: Activate Encoder Input.
- ID!, : EncoderActivateInput!): Encoder ( :
- # Deactivates an encoder.
- #
- # Arguments
- # encoderId: The encoder ID.
- ID!): UpdateResult ( :
- # Moves an encoder to a different namespace and returns the updated encoder.
- #
- # Arguments
- # encoderId: The encoder ID.
- # namespaceId: The namespace ID.
- ID!, : ID!): Encoder ( :
- # Sends a JSON-formatted command to encoder and returns the encoder response.
- #
- # Arguments
- # encoderId: The encoder ID.
- # command: The encoder command.
- ID!, : JSON): EncoderCommandMutationResponse ( :
- # Sends a response to an encoder command.
- #
- # Arguments
- # deviceId: The response to the encoder command.
- # correlationId: The correlation ID of the command to which this
- # is responding.
- # response: The JSON-formatted response to the encoder command.
- (
- String!, :
- String!, :
- JSON :
- ): EncoderCommandMutationResponse
- # Sets the encoder asset information and returns the updated encoder.
- #
- # Arguments
- # encoderId: The encoder ID.
- # input: The encoder assset information.
- (
- ID!, :
- EncoderAssetInput! :
- ): Encoder
- # Creates a log event. For internal use only.
- #
- # Arguments
- # input: The log event definition.
- LogCreateInput!): LogCreateResult ( :
- # Processes an uploaded log file. For internal use only.
- #
- # Arguments
- # input: The log file definition.
- LogFileProcessInput!): LogFileProcessResult ( :
- # Creates and returns a new namespace.
- #
- # Arguments
- # companyId: The parent company ID.
- # input: The namespace definition.
- ID!, : NamespaceCreateInput!): Namespace ( :
- # Renames a namespace and returns the updated namespace.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # name: The updated namespace name.
- ID!, : String!): Namespace ( :
- # Reissues an access key for a namespace.
- #
- # Arguments
- # namespaceId: The namespace ID.
- ID!): AccessKey ( :
- # Deletes a namespace.
- #
- # Arguments
- # namespaceId: The namespace ID.
- ID!): DeleteResult ( :
- # Sets a property on a namespace.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # input: The property definition.
- (
- ID!, :
- ExtraPropertyInput! :
- ): Namespace
- # Sets an overlayGraphicsData property on a namespace and returns the updated
- # namespace.
- #
- # Arguments
- # namespaceId: The namespace ID.
- (
- ID! :
- ): Namespace
- # Deletes a property from a namespace and returns the namespace.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # name: The name of the property to be deleted.
- (
- ID!, :
- String! :
- ): Namespace
- # Sets encoder asset information and returns the namespace.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # input: The encoder assset information.
- (
- ID!, :
- EncoderAssetInput! :
- ): Namespace
- # Creates and returns a new recording asset.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # input: The recording asset definition.
- (
- ID!, :
- RecordingAssetInput :
- ): RecordingAsset
- # Updates and returns a recording asset.
- #
- # Arguments
- # id: The recording asset ID.
- # input: The recording asset definition.
- (
- ID!, :
- RecordingAssetUpdateInput :
- ): RecordingAsset
- # Deletes a recording asset.
- #
- # Arguments
- # id: The recording asset ID.
- ID!): DeleteResult ( :
- # Sets the privledge of the namespace user.
- #
- # Arguments
- # namespaceUserId: The namespaceUser ID.
- # input: The namespaceUser privledge definition.
- (
- ID!, :
- NamespaceUserPrivledgesInput! :
- ): NamespaceUser
- }
link Require by
This element is not required by anyone