C# Class Zencoder.Zencoder

Provides API-wide Zencoder services.

显示文件 Open project: ChadBurggraf/zencoder-cs Class Usage Examples

Public Properties

Property	Type	Description
ServiceUrl	System.Uri

Public Methods

Method	Description
AccountDetails ( ) : AccountDetailsResponse	A blocking account details request/response cycle.
AccountDetails ( Action callback ) : void	A non blocking account details request/response cycle.
AccountIntegrationMode ( bool enable ) : AccountIntegrationModeResponse	A blocking account integration mode request/response cycle.
AccountIntegrationMode ( bool enable, Action callback ) : void	A non blocking account integration mode request/response cycle.
CancelJob ( int jobId ) : CancelJobResponse	A blocking cancel job request/response cycle.
CancelJob ( int jobId, Action callback ) : void	A blocking cancel request/response cycle.
CreateAccount ( string email, string password, string affiliateCode, bool termsOfService, bool newsletter ) : CreateAccountResponse	A blocking create account request/response cycle.
CreateAccount ( string email, string password, string affiliateCode, bool termsOfService, bool newsletter, Uri baseUrl ) : CreateAccountResponse	A blocking create account request/response cycle.
CreateAccount ( string email, string password, string affiliateCode, bool termsOfService, bool newsletter, Action callback ) : void	A non blocking create account request/response cycle.
CreateAccount ( string email, string password, string affiliateCode, bool termsOfService, bool newsletter, Uri baseUrl, Action callback ) : void	A non blocking create account request/response cycle.
CreateJob ( string input, IEnumerable outputs ) : CreateJobResponse	A blocking create job request/response cycle.
CreateJob ( string input, IEnumerable outputs, int downloadConnections, string region, bool test, bool mock ) : CreateJobResponse	A blocking create job request/response cycle.
CreateJob ( string input, IEnumerable outputs, Action callback ) : void	A non blocking create job request/response cycle.
CreateJob ( string input, IEnumerable outputs, int downloadConnections, string region, bool test, bool mock, Action callback ) : void	A blocking create job request/response cycle.
DeleteJob ( int jobId ) : DeleteJobResponse	A blocking delete job request/response cycle.
DeleteJob ( int jobId, Action callback ) : void	A blocking delete request/response cycle.
JobDetails ( int jobId ) : JobDetailsResponse	A blocking job details request/response cycle.
JobDetails ( int jobId, Action callback ) : void	A blocking job details request/response cycle.
JobProgress ( int outputId ) : JobProgressResponse	A blocking job progress request/response cycle.
JobProgress ( int outputId, Action callback ) : void	A non blocking job progress request/response cycle.
ListJobs ( ) : ListJobsResponse	A blocking list jobs request/response cycle.
ListJobs ( int pageNumber, int pageSize ) : ListJobsResponse	A blocking list jobs request/response cycle.
ListJobs ( Action callback ) : void	A non blocking list jobs request/response cycle.
ListJobs ( int pageNumber, int pageSize, Action callback ) : void	A non blocking list jobs request/response cycle.
ResubmitJob ( int jobId ) : ResubmitJobResponse	A blocking resubmit job request/response cycle.
ResubmitJob ( int jobId, Action callback ) : void	A blocking resubmit job request/response cycle.
Zencoder ( ) : System	Initializes a new instance of the Zencoder class.
Zencoder ( string apiKey ) : System	Initializes a new instance of the Zencoder class.
Zencoder ( string apiKey, Uri baseUrl ) : System	Initializes a new instance of the Zencoder class.

Method Details

AccountDetails() public method

A blocking account details request/response cycle.

public AccountDetails ( ) : AccountDetailsResponse
return	AccountDetailsResponse

AccountDetails() public method

A non blocking account details request/response cycle.

public AccountDetails ( Action callback ) : void
callback	Action	The call response.
return	void

AccountIntegrationMode() public method

A blocking account integration mode request/response cycle.

public AccountIntegrationMode ( bool enable ) : AccountIntegrationModeResponse
enable	bool	A value indicating whether to enable integration mode for the account.
return	AccountIntegrationModeResponse

AccountIntegrationMode() public method

A non blocking account integration mode request/response cycle.

public AccountIntegrationMode ( bool enable, Action callback ) : void
enable	bool	A value indicating whether to enable integration mode for the account.
callback	Action	The call response.
return	void

CancelJob() public method

A blocking cancel job request/response cycle.

public CancelJob ( int jobId ) : CancelJobResponse
jobId	int	The ID of the job to cancel.
return	CancelJobResponse

CancelJob() public method

A blocking cancel request/response cycle.

public CancelJob ( int jobId, Action callback ) : void
jobId	int	The ID of the job to cancel.
callback	Action	The call response.
return	void

CreateAccount() public static method

A blocking create account request/response cycle.

public static CreateAccount ( string email, string password, string affiliateCode, bool termsOfService, bool newsletter ) : CreateAccountResponse
email	string	The email address to create the account with.
password	string	The password to create the account with.
affiliateCode	string	The affiliate code to create the account with, if applicable.
termsOfService	bool	A value indicating whether the terms of service are agreed to.
newsletter	bool	A value indicating whether to subscribe the email address to the newsletter.
return	CreateAccountResponse

CreateAccount() public static method

A blocking create account request/response cycle.

public static CreateAccount ( string email, string password, string affiliateCode, bool termsOfService, bool newsletter, Uri baseUrl ) : CreateAccountResponse
email	string	The email address to create the account with.
password	string	The password to create the account with.
affiliateCode	string	The affiliate code to create the account with, if applicable.
termsOfService	bool	A value indicating whether the terms of service are agreed to.
newsletter	bool	A value indicating whether to subscribe the email address to the newsletter.
baseUrl	System.Uri	The service base URL.
return	CreateAccountResponse

CreateAccount() public static method

A non blocking create account request/response cycle.

public static CreateAccount ( string email, string password, string affiliateCode, bool termsOfService, bool newsletter, Action callback ) : void
email	string	The email address to create the account with.
password	string	The password to create the account with.
affiliateCode	string	The affiliate code to create the account with, if applicable.
termsOfService	bool	A value indicating whether the terms of service are agreed to.
newsletter	bool	A value indicating whether to subscribe the email address to the newsletter.
callback	Action	The call response.
return	void

CreateAccount() public static method

A non blocking create account request/response cycle.

public static CreateAccount ( string email, string password, string affiliateCode, bool termsOfService, bool newsletter, Uri baseUrl, Action callback ) : void
email	string	The email address to create the account with.
password	string	The password to create the account with.
affiliateCode	string	The affiliate code to create the account with, if applicable.
termsOfService	bool	A value indicating whether the terms of service are agreed to.
newsletter	bool	A value indicating whether to subscribe the email address to the newsletter.
baseUrl	System.Uri	The service base URL.
callback	Action	The call response.
return	void

CreateJob() public method

A blocking create job request/response cycle.

public CreateJob ( string input, IEnumerable outputs ) : CreateJobResponse
input	string	The URL of the input file.
outputs	IEnumerable	The output definition collection.
return	CreateJobResponse

CreateJob() public method

A blocking create job request/response cycle.

public CreateJob ( string input, IEnumerable outputs, int downloadConnections, string region, bool test, bool mock ) : CreateJobResponse
input	string	The URL of the input file.
outputs	IEnumerable	The output definition collection.
downloadConnections	int	The number of download connections to use when fetching the input file.
region	string	The region to perform the job in.
test	bool	A value indicating whether to use test mode.
mock	bool	A value indicating whether to mock the response rather than actually creating a job.
return	CreateJobResponse

CreateJob() public method

A non blocking create job request/response cycle.

public CreateJob ( string input, IEnumerable outputs, Action callback ) : void
input	string	The URL of the input file.
outputs	IEnumerable	The output definition collection.
callback	Action	The call response.
return	void

CreateJob() public method

A blocking create job request/response cycle.

public CreateJob ( string input, IEnumerable outputs, int downloadConnections, string region, bool test, bool mock, Action callback ) : void
input	string	The URL of the input file.
outputs	IEnumerable	The output definition collection.
downloadConnections	int	The number of download connections to use when fetching the input file.
region	string	The region to perform the job in.
test	bool	A value indicating whether to use test mode.
mock	bool	A value indicating whether to mock the response rather than actually creating a job.
callback	Action	The call response.
return	void

DeleteJob() public method

A blocking delete job request/response cycle.

public DeleteJob ( int jobId ) : DeleteJobResponse
jobId	int	The ID of the job to delete.
return	DeleteJobResponse

DeleteJob() public method

A blocking delete request/response cycle.

public DeleteJob ( int jobId, Action callback ) : void
jobId	int	The ID of the job to delete.
callback	Action	The call response.
return	void

JobDetails() public method

A blocking job details request/response cycle.

public JobDetails ( int jobId ) : JobDetailsResponse
jobId	int	The ID of the job to get details for.
return	JobDetailsResponse

JobDetails() public method

A blocking job details request/response cycle.

public JobDetails ( int jobId, Action callback ) : void
jobId	int	The ID of the job to get details for.
callback	Action	The call response.
return	void

JobProgress() public method

A blocking job progress request/response cycle.

public JobProgress ( int outputId ) : JobProgressResponse
outputId	int	The ID of the output (NOT the job ID) to get progress for.
return	JobProgressResponse

JobProgress() public method

A non blocking job progress request/response cycle.

public JobProgress ( int outputId, Action callback ) : void
outputId	int	The ID of the output (NOT the job ID) to get progress for.
callback	Action	The call response.
return	void

ListJobs() public method

A blocking list jobs request/response cycle.

public ListJobs ( ) : ListJobsResponse
return	ListJobsResponse

ListJobs() public method

A blocking list jobs request/response cycle.

public ListJobs ( int pageNumber, int pageSize ) : ListJobsResponse
pageNumber	int	The page number of jobs to list, if applicable.
pageSize	int	The page size of jobs to list, if applicable.
return	ListJobsResponse

ListJobs() public method

A non blocking list jobs request/response cycle.

public ListJobs ( Action callback ) : void
callback	Action	The call response.
return	void

ListJobs() public method

A non blocking list jobs request/response cycle.

public ListJobs ( int pageNumber, int pageSize, Action callback ) : void
pageNumber	int	The page number of jobs to list, if applicable.
pageSize	int	The page size of jobs to list, if applicable.
callback	Action	The call response.
return	void

ResubmitJob() public method

A blocking resubmit job request/response cycle.

public ResubmitJob ( int jobId ) : ResubmitJobResponse
jobId	int	The ID of the job to resubmit.
return	ResubmitJobResponse

ResubmitJob() public method

A blocking resubmit job request/response cycle.

public ResubmitJob ( int jobId, Action callback ) : void
jobId	int	The ID of the job to resubmit.
callback	Action	The call response.
return	void

Zencoder() public method

Initializes a new instance of the Zencoder class.

public Zencoder ( ) : System
return	System

Zencoder() public method

Initializes a new instance of the Zencoder class.

public Zencoder ( string apiKey ) : System
apiKey	string	The API key to use when connecting to the service.
return	System

Zencoder() public method

Initializes a new instance of the Zencoder class.

public Zencoder ( string apiKey, Uri baseUrl ) : System
apiKey	string	The API key to use when connecting to the service.
baseUrl	System.Uri	The service base URL.
return	System

Property Details

ServiceUrl public_oe static_oe property

Gets the default API base URL.

public static Uri,System ServiceUrl
return	System.Uri